FieldPresenceClause

java.lang.Object
- lumis.portal.bigdata.query.FieldPresenceClause

All Implemented Interfaces:

ISearchQueryFilter
```
@StableMinor(version="17.0",
             sinceVersion="8.1")
public class FieldPresenceClause
extends java.lang.Object
implements ISearchQueryFilter
```
ISearchQueryFilter that checks whether a given field is present or not, accordingly to the chosen operator.
A field is present if a given document has it and it has a non-null value.
The default operator is FieldPresenceClause.Operator.PRESENT.

Since:

8.1.0

Version:

$Revision$ $Date$

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class FieldPresenceClause.Operator
The available operators for this clause.

Constructor Summary

Constructors
Constructor Description

FieldPresenceClause(DocumentTypeField field)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DocumentTypeField`	`getField()`	Returns the field that will be checked.
`FieldPresenceClause.Operator`	`getOperator()`	Returns the operator of this clause.
`FieldPresenceClause`	`setOperator(FieldPresenceClause.Operator operator)`	Sets the operator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FieldPresenceClause
```
public FieldPresenceClause(DocumentTypeField field)
```
    Creates a new instance.
    
    Parameters:
    
    field - the field to be checked.
    
    Since:
    
    8.1.0
- Method Detail
  - setOperator
```
public FieldPresenceClause setOperator(FieldPresenceClause.Operator operator)
```
    Sets the operator.
    
    Parameters:
    
    operator - the operator.
    
    Returns:
    
    this clause.
    
    Since:
    
    8.1.0
  - getOperator
```
public FieldPresenceClause.Operator getOperator()
```
    Returns the operator of this clause.
    
    Returns:
    
    the operator of this clause.
    
    Since:
    
    8.1.0
  - getField
```
public DocumentTypeField getField()
```
    Returns the field that will be checked.
    
    Returns:
    
    the field that will be checked.
    
    Since:
    
    8.1.0