QueryCondition (OJAI Core Library for Java v. 3.0)

All Superinterfaces:: Buildable, Container, JsonString

@API.Public
 @API.ImmutableOnBuild
public interface QueryCondition
extends Buildable, Container, JsonString

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class QueryCondition.Op

Nested Classes
Modifier and Type	Interface and Description
`static class`	`QueryCondition.Op`

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`TAGS_BETWEEN` OJAI tag name for BETWEEN operator.
`static String[]`	`TAGS_EQUAL` OJAI tag name for the `QueryCondition.Op.EQUAL` operator.
`static String[]`	`TAGS_EXISTS` OJAI tag name for the `exists(FieldPath)` operator.
`static String[]`	`TAGS_GREATER` OJAI tag name for the `QueryCondition.Op.GREATER` operator.
`static String[]`	`TAGS_GREATER_OR_EQUAL` OJAI tag name for the `QueryCondition.Op.GREATER_OR_EQUAL` operator.
`static String[]`	`TAGS_IN` OJAI tag name for the `in(FieldPath, List)` operator.
`static String[]`	`TAGS_LESS` OJAI tag name for the `QueryCondition.Op.LESS` operator.
`static String[]`	`TAGS_LESS_OR_EQUAL` OJAI tag name for the `QueryCondition.Op.LESS_OR_EQUAL` operator.
`static String[]`	`TAGS_LIKE` OJAI tag name for the `like(FieldPath, String)` operator.
`static String[]`	`TAGS_MATCHES` OJAI tag name for the `matches(FieldPath, String)` operator.
`static String[]`	`TAGS_NOT_EQUAL` OJAI tag name for the `QueryCondition.Op.NOT_EQUAL` operator.
`static String[]`	`TAGS_NOT_EXISTS` OJAI tag name for the `notExists(FieldPath)` operator.
`static String[]`	`TAGS_NOT_IN` OJAI tag name for the `notIn(FieldPath, List)` operator.
`static String[]`	`TAGS_NOT_LIKE` OJAI tag name for the `notLike(FieldPath, String)` operator.
`static String[]`	`TAGS_NOT_MATCHES` OJAI tag name for the `notMatches(FieldPath, String)` operator.
`static String[]`	`TAGS_NOT_TYPE_OF` OJAI tag name for the `#notTypeOf(FieldPath, Type)` operator.
`static String[]`	`TAGS_SIZE_OF` OJAI tag name for the `sizeOf(FieldPath, Op, long)` operator.
`static String[]`	`TAGS_TYPE_OF` OJAI tag name for the `#typeOf(FieldPath, Type)` operator.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`QueryCondition`	`and()` Begins a new AND compound condition block.
`QueryCondition`	`build()` Closes all nested compound condition blocks.
`QueryCondition`	`close()` Closes a compound condition block.
`QueryCondition`	`condition(QueryCondition conditionToAdd)` Appends the specified condition to the current condition block.
`QueryCondition`	`elementAnd(FieldPath fieldPath)` Begins a new element-wise AND compound condition block.
`QueryCondition`	`elementAnd(String fieldPath)` Begins a new element-wise AND compound condition block.
`QueryCondition`	`equals(FieldPath path, List<? extends Object> value)` Adds a condition that tests if the `Value` at the specified `FieldPath` equals the specified `List` value.
`QueryCondition`	`equals(FieldPath path, Map<String,? extends Object> value)` Adds a condition that tests if the `Value` at the specified `FieldPath` equals the specified `Map` value.
`QueryCondition`	`equals(String path, List<? extends Object> value)` Adds a condition that tests if the `Value` at the specified `FieldPath` equals the specified `List` value.
`QueryCondition`	`equals(String path, Map<String,? extends Object> value)` Adds a condition that tests if the `Value` at the specified `FieldPath` equals the specified `Map` value.
`QueryCondition`	`exists(FieldPath path)` Adds a condition that tests for existence of the specified `FieldPath`.
`QueryCondition`	`exists(String path)` Adds a condition that tests for existence of the specified `FieldPath`.
`QueryCondition`	`in(FieldPath path, List<? extends Object> listOfValue)` Adds a condition that tests if the `Value` at the specified `FieldPath` is equal to at least one of the values in the specified `List`.
`QueryCondition`	`in(String path, List<? extends Object> listOfValue)` Adds a condition that tests if the `Value` at the specified `FieldPath` is equal to at least one of the values in the specified `List`.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, BigDecimal value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `BigDecimal` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, boolean value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `boolean` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, byte value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `byte` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, ByteBuffer value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `ByteBuffer` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, double value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `double` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, float value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `float` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, int value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `int` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, long value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `long` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, ODate value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `Date` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, OInterval value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `Interval` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, OTime value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `Time` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, OTimestamp value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `Timestamp` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, short value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `short` value.
`QueryCondition`	`is(FieldPath path, QueryCondition.Op op, String value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `String` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, BigDecimal value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `BigDecimal` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, boolean value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `boolean` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, byte value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `byte` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, ByteBuffer value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `ByteBuffer` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, double value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `double` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, float value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `float` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, int value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `int` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, long value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `long` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, ODate value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `Date` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, OInterval value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `Interval` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, OTime value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `Time` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, OTimestamp value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `Timestamp` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, short value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `short` value.
`QueryCondition`	`is(String path, QueryCondition.Op op, String value)` Adds a condition that tests if the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` against the specified `String` value.
`QueryCondition`	`like(FieldPath path, String likeExpression)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and matches the specified SQL LIKE expression.
`QueryCondition`	`like(FieldPath path, String likeExpression, Character escapeChar)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and matches the specified SQL LIKE expression optionally escaped with the specified escape character.
`QueryCondition`	`like(String path, String likeExpression)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and matches the specified SQL LIKE expression.
`QueryCondition`	`like(String path, String likeExpression, Character escapeChar)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and matches the specified SQL LIKE expression optionally escaped with the specified escape character.
`QueryCondition`	`matches(FieldPath path, String regex)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and matches the specified regular expression.
`QueryCondition`	`matches(String path, String regex)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and matches the specified regular expression.
`QueryCondition`	`notEquals(FieldPath path, List<? extends Object> value)` Adds a condition that tests if the `Value` at the specified `FieldPath` does not equal the specified `List` value.
`QueryCondition`	`notEquals(FieldPath path, Map<String,? extends Object> value)` Adds a condition that tests if the `Value` at the specified `FieldPath` does not equal the specified `Map` value.
`QueryCondition`	`notEquals(String path, List<? extends Object> value)` Adds a condition that tests if the `Value` at the specified `FieldPath` does not equal the specified `List` value.
`QueryCondition`	`notEquals(String path, Map<String,? extends Object> value)` Adds a condition that tests if the `Value` at the specified `FieldPath` does not equal the specified `Map` value.
`QueryCondition`	`notExists(FieldPath path)` Adds a condition that tests for non-existence of the specified `FieldPath`.
`QueryCondition`	`notExists(String path)` Adds a condition that tests for non-existence of the specified `FieldPath`.
`QueryCondition`	`notIn(FieldPath path, List<? extends Object> listOfValue)` Adds a condition that tests if the `Value` at the specified `FieldPath` is not equal to any of the values in the specified `List`.
`QueryCondition`	`notIn(String path, List<? extends Object> listOfValue)` Adds a condition that tests if the `Value` at the specified `FieldPath` is not equal to any of the values in the specified `List`.
`QueryCondition`	`notLike(FieldPath path, String likeExpression)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and does not match the specified SQL LIKE expression.
`QueryCondition`	`notLike(FieldPath path, String likeExpression, Character escapeChar)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and does not match the specified SQL LIKE expression optionally escaped with the specified escape character.
`QueryCondition`	`notLike(String path, String likeExpression)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and does not match the specified SQL LIKE expression.
`QueryCondition`	`notLike(String path, String likeExpression, Character escapeChar)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and does not match the specified SQL LIKE expression optionally escaped with the specified escape character.
`QueryCondition`	`notMatches(FieldPath path, String regex)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and does not match the specified regular expression.
`QueryCondition`	`notMatches(String path, String regex)` Adds a condition that tests if the `Value` at the specified `FieldPath` is a String and does not match the specified regular expression.
`QueryCondition`	`notTypeOf(FieldPath path, Value.Type type)` Adds a condition that tests if the `Value` at the specified `FieldPath` is not of the specified `Type`.
`QueryCondition`	`notTypeOf(String path, Value.Type type)` Adds a condition that tests if the `Value` at the specified `FieldPath` is not of the specified `Type`.
`QueryCondition`	`or()` Begins a new OR compound condition block.
`QueryCondition`	`sizeOf(FieldPath path, QueryCondition.Op op, long size)` Adds a condition that tests if the size of the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` and the size.
`QueryCondition`	`sizeOf(String path, QueryCondition.Op op, long size)` Adds a condition that tests if the size of the `Value` at the specified `FieldPath` satisfies the given `QueryCondition.Op` and the size.
`QueryCondition`	`typeOf(FieldPath path, Value.Type type)` Adds a condition that tests if the `Value` at the specified `FieldPath` is of the specified `Type`.
`QueryCondition`	`typeOf(String path, Value.Type type)` Adds a condition that tests if the `Value` at the specified `FieldPath` is of the specified `Type`.

Methods inherited from interface org.ojai.Buildable
isBuilt

Methods inherited from interface org.ojai.Container
empty, isEmpty, isReadOnly, size

Methods inherited from interface org.ojai.JsonString
asJsonString, asJsonString

- Field Detail
  - TAGS_LESS
```
static final String[] TAGS_LESS
```
    OJAI tag name for the QueryCondition.Op.LESS operator.
  - TAGS_LESS_OR_EQUAL
```
static final String[] TAGS_LESS_OR_EQUAL
```
    OJAI tag name for the QueryCondition.Op.LESS_OR_EQUAL operator.
  - TAGS_EQUAL
```
static final String[] TAGS_EQUAL
```
    OJAI tag name for the QueryCondition.Op.EQUAL operator.
  - TAGS_NOT_EQUAL
```
static final String[] TAGS_NOT_EQUAL
```
    OJAI tag name for the QueryCondition.Op.NOT_EQUAL operator.
  - TAGS_GREATER_OR_EQUAL
```
static final String[] TAGS_GREATER_OR_EQUAL
```
    OJAI tag name for the QueryCondition.Op.GREATER_OR_EQUAL operator.
  - TAGS_GREATER
```
static final String[] TAGS_GREATER
```
    OJAI tag name for the QueryCondition.Op.GREATER operator.
  - TAGS_EXISTS
```
static final String[] TAGS_EXISTS
```
    OJAI tag name for the exists(FieldPath) operator.
  - TAGS_NOT_EXISTS
```
static final String[] TAGS_NOT_EXISTS
```
    OJAI tag name for the notExists(FieldPath) operator.
  - TAGS_TYPE_OF
```
static final String[] TAGS_TYPE_OF
```
    OJAI tag name for the #typeOf(FieldPath, Type) operator.
  - TAGS_NOT_TYPE_OF
```
static final String[] TAGS_NOT_TYPE_OF
```
    OJAI tag name for the #notTypeOf(FieldPath, Type) operator.
  - TAGS_LIKE
```
static final String[] TAGS_LIKE
```
    OJAI tag name for the like(FieldPath, String) operator.
  - TAGS_NOT_LIKE
```
static final String[] TAGS_NOT_LIKE
```
    OJAI tag name for the notLike(FieldPath, String) operator.
  - TAGS_SIZE_OF
```
static final String[] TAGS_SIZE_OF
```
    OJAI tag name for the sizeOf(FieldPath, Op, long) operator.
  - TAGS_IN
```
static final String[] TAGS_IN
```
    OJAI tag name for the in(FieldPath, List) operator.
  - TAGS_NOT_IN
```
static final String[] TAGS_NOT_IN
```
    OJAI tag name for the notIn(FieldPath, List) operator.
  - TAGS_MATCHES
```
static final String[] TAGS_MATCHES
```
    OJAI tag name for the matches(FieldPath, String) operator.
  - TAGS_NOT_MATCHES
```
static final String[] TAGS_NOT_MATCHES
```
    OJAI tag name for the notMatches(FieldPath, String) operator.
  - TAGS_BETWEEN
```
static final String[] TAGS_BETWEEN
```
    OJAI tag name for BETWEEN operator.
- Method Detail
  - and
```
QueryCondition and()
```
    Begins a new AND compound condition block.
    
    Returns:
    
    this for chaining
  - or
```
QueryCondition or()
```
    Begins a new OR compound condition block.
    
    Returns:
    
    this for chaining
  - elementAnd
```
QueryCondition elementAnd(String fieldPath)
```
    Begins a new element-wise AND compound condition block.
    
    Parameters:
    
    fieldPath - the array expression for the fields' container
    
    Returns:
    
    this for chaining
  - elementAnd
```
QueryCondition elementAnd(FieldPath fieldPath)
```
    Begins a new element-wise AND compound condition block.
    
    Parameters:
    
    fieldPath - the array expression for the fields' container
    
    Returns:
    
    this for chaining
  - close
```
QueryCondition close()
```
    Closes a compound condition block.
    
    Returns:
    
    this for chaining
  - build
```
QueryCondition build()
```
    Closes all nested compound condition blocks.
    
    Specified by:
    
    build in interface Buildable
    
    Returns:
    
    this
  - condition
```
QueryCondition condition(@API.NonNullable
                         QueryCondition conditionToAdd)
```
    Appends the specified condition to the current condition block.
    
    Returns:
    
    this for chaining
  - exists
```
QueryCondition exists(@API.NonNullable
                      String path)
```
    Adds a condition that tests for existence of the specified FieldPath.
    
    Parameters:
    
    path - the FieldPath to test
    
    Returns:
    
    this for chained invocation
  - exists
```
QueryCondition exists(@API.NonNullable
                      FieldPath path)
```
    Adds a condition that tests for existence of the specified FieldPath.
    
    Parameters:
    
    path - the FieldPath to test
    
    Returns:
    
    this for chained invocation
  - notExists
```
QueryCondition notExists(@API.NonNullable
                         String path)
```
    Adds a condition that tests for non-existence of the specified FieldPath.
    
    Parameters:
    
    path - the FieldPath to test
    
    Returns:
    
    this for chained invocation
  - notExists
```
QueryCondition notExists(@API.NonNullable
                         FieldPath path)
```
    Adds a condition that tests for non-existence of the specified FieldPath.
    
    Parameters:
    
    path - the FieldPath to test
    
    Returns:
    
    this for chained invocation
  - in
```
QueryCondition in(@API.NonNullable
                  String path,
                  @API.NonNullable
                  List<? extends Object> listOfValue)
```
    Adds a condition that tests if the Value at the specified FieldPath is equal to at least one of the values in the specified List.
    
    Parameters:
    
    path - the FieldPath to test
    
    listOfValue - the List of values to test against
    
    Returns:
    
    this for chained invocation
  - in
```
QueryCondition in(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  List<? extends Object> listOfValue)
```
    Adds a condition that tests if the Value at the specified FieldPath is equal to at least one of the values in the specified List.
    
    Parameters:
    
    path - the FieldPath to test
    
    listOfValue - the List of values to test against
    
    Returns:
    
    this for chained invocation
  - notIn
```
QueryCondition notIn(@API.NonNullable
                     String path,
                     @API.NonNullable
                     List<? extends Object> listOfValue)
```
    Adds a condition that tests if the Value at the specified FieldPath is not equal to any of the values in the specified List.
    
    Parameters:
    
    path - the FieldPath to test
    
    listOfValue - the List of values to test against
    
    Returns:
    
    this for chained invocation
  - notIn
```
QueryCondition notIn(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     List<? extends Object> listOfValue)
```
    Adds a condition that tests if the Value at the specified FieldPath is not equal to any of the values in the specified List.
    
    Parameters:
    
    path - the FieldPath to test
    
    listOfValue - the List of values to test against
    
    Returns:
    
    this for chained invocation
  - typeOf
```
QueryCondition typeOf(@API.NonNullable
                      String path,
                      @API.NonNullable
                      Value.Type type)
```
    Adds a condition that tests if the Value at the specified FieldPath is of the specified Type.
    
    Parameters:
    
    path - the FieldPath to test
    
    Returns:
    
    this for chained invocation
  - typeOf
```
QueryCondition typeOf(@API.NonNullable
                      FieldPath path,
                      @API.NonNullable
                      Value.Type type)
```
    Adds a condition that tests if the Value at the specified FieldPath is of the specified Type.
    
    Parameters:
    
    path - the FieldPath to test
    
    Returns:
    
    this for chained invocation
  - notTypeOf
```
QueryCondition notTypeOf(@API.NonNullable
                         String path,
                         @API.NonNullable
                         Value.Type type)
```
    Adds a condition that tests if the Value at the specified FieldPath is not of the specified Type.
    
    Parameters:
    
    path - the FieldPath to test
    
    Returns:
    
    this for chained invocation
  - notTypeOf
```
QueryCondition notTypeOf(@API.NonNullable
                         FieldPath path,
                         @API.NonNullable
                         Value.Type type)
```
    Adds a condition that tests if the Value at the specified FieldPath is not of the specified Type.
    
    Parameters:
    
    path - the FieldPath to test
    
    Returns:
    
    this for chained invocation
  - matches
```
QueryCondition matches(@API.NonNullable
                       String path,
                       @API.NonNullable
                       String regex)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified regular expression.
    
    Parameters:
    
    path - the FieldPath to test
    
    regex - the reference regular expression
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    PatternSyntaxException - if the expression's syntax is invalid
  - matches
```
QueryCondition matches(@API.NonNullable
                       FieldPath path,
                       @API.NonNullable
                       String regex)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified regular expression.
    
    Parameters:
    
    path - the FieldPath to test
    
    regex - the reference regular expression
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    PatternSyntaxException - if the expression's syntax is invalid
  - notMatches
```
QueryCondition notMatches(@API.NonNullable
                          String path,
                          @API.NonNullable
                          String regex)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified regular expression.
    
    Parameters:
    
    path - the FieldPath to test
    
    regex - the reference regular expression
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    PatternSyntaxException - if the expression's syntax is invalid
  - notMatches
```
QueryCondition notMatches(@API.NonNullable
                          FieldPath path,
                          @API.NonNullable
                          String regex)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified regular expression.
    
    Parameters:
    
    path - the FieldPath to test
    
    regex - the reference regular expression
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    PatternSyntaxException - if the expression's syntax is invalid
  - like
```
QueryCondition like(@API.NonNullable
                    String path,
                    @API.NonNullable
                    String likeExpression)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified SQL LIKE expression.
    
    Parameters:
    
    path - the FieldPath to test
    
    likeExpression - the reference LIKE pattern
    
    Returns:
    
    this for chained invocation
  - like
```
QueryCondition like(@API.NonNullable
                    FieldPath path,
                    @API.NonNullable
                    String likeExpression)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified SQL LIKE expression.
    
    Parameters:
    
    path - the FieldPath to test
    
    likeExpression - the reference LIKE pattern
    
    Returns:
    
    this for chained invocation
  - like
```
QueryCondition like(@API.NonNullable
                    String path,
                    @API.NonNullable
                    String likeExpression,
                    @API.NonNullable
                    Character escapeChar)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified SQL LIKE expression optionally escaped with the specified escape character.
    
    Parameters:
    
    path - the FieldPath to test
    
    likeExpression - the reference LIKE pattern
    
    escapeChar - the escape character in the LIKE pattern
    
    Returns:
    
    this for chained invocation
  - like
```
QueryCondition like(@API.NonNullable
                    FieldPath path,
                    @API.NonNullable
                    String likeExpression,
                    @API.NonNullable
                    Character escapeChar)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and matches the specified SQL LIKE expression optionally escaped with the specified escape character.
    
    Parameters:
    
    path - the FieldPath to test
    
    likeExpression - the reference LIKE pattern
    
    escapeChar - the escape character in the LIKE pattern
    
    Returns:
    
    this for chained invocation
  - notLike
```
QueryCondition notLike(@API.NonNullable
                       String path,
                       @API.NonNullable
                       String likeExpression)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified SQL LIKE expression.
    
    Parameters:
    
    path - the FieldPath to test
    
    likeExpression - the reference LIKE pattern
    
    Returns:
    
    this for chained invocation
  - notLike
```
QueryCondition notLike(@API.NonNullable
                       FieldPath path,
                       @API.NonNullable
                       String likeExpression)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified SQL LIKE expression.
    
    Parameters:
    
    path - the FieldPath to test
    
    likeExpression - the reference LIKE pattern
    
    Returns:
    
    this for chained invocation
  - notLike
```
QueryCondition notLike(@API.NonNullable
                       String path,
                       @API.NonNullable
                       String likeExpression,
                       @API.NonNullable
                       Character escapeChar)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified SQL LIKE expression optionally escaped with the specified escape character.
    
    Parameters:
    
    path - the FieldPath to test
    
    likeExpression - the reference LIKE pattern
    
    escapeChar - the escape character in the LIKE pattern
    
    Returns:
    
    this for chained invocation
  - notLike
```
QueryCondition notLike(@API.NonNullable
                       FieldPath path,
                       @API.NonNullable
                       String likeExpression,
                       @API.NonNullable
                       Character escapeChar)
```
    Adds a condition that tests if the Value at the specified FieldPath is a String and does not match the specified SQL LIKE expression optionally escaped with the specified escape character.
    
    Parameters:
    
    path - the FieldPath to test
    
    likeExpression - the reference LIKE pattern
    
    escapeChar - the escape character in the LIKE pattern
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  boolean value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified boolean value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference boolean Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  boolean value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified boolean value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference boolean Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  String value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified String value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference String Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  String value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified String value.
    
    Parameters:
    
    path - the FieldPath to test.
    
    op - the QueryCondition.Op to apply
    
    value - the reference String Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  byte value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified byte value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference byte Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  byte value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified byte value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference byte Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  short value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified short value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference short Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  short value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified short value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference short Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  int value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified int value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference int Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  int value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified int value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference int Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  long value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified long value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference long Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  long value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified long value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference long Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  float value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified float value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference float Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  float value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified float value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference float Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  double value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified double value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference double Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  double value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified double value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference double Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  BigDecimal value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified BigDecimal value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference BigDecimal Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  BigDecimal value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified BigDecimal value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference BigDecimal Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  ODate value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Date value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference Date Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  ODate value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Date value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference Date Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  OTime value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Time value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference Time Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  OTime value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Time value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference Time Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  OTimestamp value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Timestamp value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference Timestamp Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  OTimestamp value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Timestamp value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference Timestamp Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  OInterval value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Interval value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference Interval Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  OInterval value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified Interval value.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference Interval Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  String path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  ByteBuffer value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified ByteBuffer value. Only the byte sequence between the position and limit in the ByteBuffer is used as the reference value. The function does not alter the passed ByteBuffer state or content.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference ByteBuffer Value
    
    Returns:
    
    this for chained invocation
  - is
```
QueryCondition is(@API.NonNullable
                  FieldPath path,
                  @API.NonNullable
                  QueryCondition.Op op,
                  @API.NonNullable
                  ByteBuffer value)
```
    Adds a condition that tests if the Value at the specified FieldPath satisfies the given QueryCondition.Op against the specified ByteBuffer value. Only the byte sequence between the position and limit in the ByteBuffer is used as the reference value. The function does not alter the passed ByteBuffer state or content.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    value - the reference ByteBuffer Value
    
    Returns:
    
    this for chained invocation
  - equals
```
QueryCondition equals(@API.NonNullable
                      String path,
                      @API.NonNullable
                      Map<String,? extends Object> value)
```
    Adds a condition that tests if the Value at the specified FieldPath equals the specified Map value. Two Maps are considered equal if and only if they contain the same key-value pair in the same order.
    
    Parameters:
    
    path - the FieldPath to test
    
    value - the reference Map Value
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    TypeException - if a value at any level in the specified Map is not one of the Value types
  - equals
```
QueryCondition equals(@API.NonNullable
                      FieldPath path,
                      @API.NonNullable
                      Map<String,? extends Object> value)
```
    Adds a condition that tests if the Value at the specified FieldPath equals the specified Map value. Two Maps are considered equal if and only if they contain the same key-value pair in the same order.
    
    Parameters:
    
    path - the FieldPath to test
    
    value - the reference Map Value
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    TypeException - if a value at any level in the specified Map is not one of the Value types
  - equals
```
QueryCondition equals(@API.NonNullable
                      String path,
                      @API.NonNullable
                      List<? extends Object> value)
```
    Adds a condition that tests if the Value at the specified FieldPath equals the specified List value.
    
    Parameters:
    
    path - the FieldPath to test
    
    value - the reference List Value
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    TypeException - if a value in the specified List is not one of the Value types
  - equals
```
QueryCondition equals(@API.NonNullable
                      FieldPath path,
                      @API.NonNullable
                      List<? extends Object> value)
```
    Adds a condition that tests if the Value at the specified FieldPath equals the specified List value.
    
    Parameters:
    
    path - the FieldPath to test
    
    value - the reference List Value
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    TypeException - if a value in the specified List is not one of the Value types
  - notEquals
```
QueryCondition notEquals(@API.NonNullable
                         String path,
                         @API.NonNullable
                         Map<String,? extends Object> value)
```
    Adds a condition that tests if the Value at the specified FieldPath does not equal the specified Map value. Two Maps are considered equal if and only if they contain the same key-value pair in the same order.
    
    Parameters:
    
    path - the FieldPath to test
    
    value - the reference Map Value
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    TypeException - if a value at any level in the specified Map is not one of the Value types
  - notEquals
```
QueryCondition notEquals(@API.NonNullable
                         FieldPath path,
                         @API.NonNullable
                         Map<String,? extends Object> value)
```
    Adds a condition that tests if the Value at the specified FieldPath does not equal the specified Map value. Two Maps are considered equal if and only if they contain the same key-value pair in the same order.
    
    Parameters:
    
    path - the FieldPath to test
    
    value - the reference Map Value
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    TypeException - if a value at any level in the specified Map is not one of the Value types
  - notEquals
```
QueryCondition notEquals(@API.NonNullable
                         String path,
                         @API.NonNullable
                         List<? extends Object> value)
```
    Adds a condition that tests if the Value at the specified FieldPath does not equal the specified List value.
    
    Parameters:
    
    path - the FieldPath to test
    
    value - the reference List Value
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    TypeException - if a value in the specified List is not one of the Value types
  - notEquals
```
QueryCondition notEquals(@API.NonNullable
                         FieldPath path,
                         @API.NonNullable
                         List<? extends Object> value)
```
    Adds a condition that tests if the Value at the specified FieldPath does not equal the specified List value.
    
    Parameters:
    
    path - the FieldPath to test
    
    value - the reference List Value
    
    Returns:
    
    this for chained invocation
    
    Throws:
    
    TypeException - if a value in the specified List is not one of the Value types
  - sizeOf
```
QueryCondition sizeOf(@API.NonNullable
                      String path,
                      @API.NonNullable
                      QueryCondition.Op op,
                      long size)
```
    Adds a condition that tests if the size of the Value at the specified FieldPath satisfies the given QueryCondition.Op and the size. The value must be one of the following types: STRING, BINARY, MAP or ARRAY.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    size - the reference size of Value
    
    Returns:
    
    this for chained invocation
  - sizeOf
```
QueryCondition sizeOf(@API.NonNullable
                      FieldPath path,
                      @API.NonNullable
                      QueryCondition.Op op,
                      long size)
```
    Adds a condition that tests if the size of the Value at the specified FieldPath satisfies the given QueryCondition.Op and the size. The value must be one of the following types: STRING, BINARY, MAP or ARRAY.
    
    Parameters:
    
    path - the FieldPath to test
    
    op - the QueryCondition.Op to apply
    
    size - the reference size of Value
    
    Returns:
    
    this for chained invocation

Interface QueryCondition

Nested Class Summary

Field Summary

Method Summary

Methods inherited from interface org.ojai.Buildable

Methods inherited from interface org.ojai.Container

Methods inherited from interface org.ojai.JsonString

Field Detail

TAGS_LESS

TAGS_LESS_OR_EQUAL

TAGS_EQUAL

TAGS_NOT_EQUAL

TAGS_GREATER_OR_EQUAL

TAGS_GREATER

TAGS_EXISTS

TAGS_NOT_EXISTS

TAGS_TYPE_OF

TAGS_NOT_TYPE_OF

TAGS_LIKE

TAGS_NOT_LIKE

TAGS_SIZE_OF

TAGS_IN

TAGS_NOT_IN

TAGS_MATCHES

TAGS_NOT_MATCHES

TAGS_BETWEEN

Method Detail

and

or

elementAnd

elementAnd

close

build

condition

exists

exists

notExists

notExists

in

in

notIn

notIn

typeOf

typeOf

notTypeOf

notTypeOf

matches

matches

notMatches

notMatches

like

like

like

like

notLike

notLike

notLike

notLike

is

is

is

is

is

is

is

is

is

is

is

is

is

is

is

is

is

is

is

is

is

is