com.cloudant.client.api.query

Class PredicateExpression

java.lang.Object

com.cloudant.client.api.query.PredicateExpression

public class PredicateExpression
extends java.lang.Object

PredicateExpressions are the same as ordinary Expressions, but instead of taking a field name as one of their arguments, they are combined with a PredicatedOperation.

See Also:

Expression, PredicatedOperation

Method Summary

Modifier and Type	Method and Description
static PredicateExpression	all(java.lang.Object... rhs) Matches an array value if it contains all the elements of the argument array
static PredicateExpression	eq(java.lang.Object rhs) The field is equal to the argument
static PredicateExpression	exists(boolean rhs) The field exists or not, regardless of its value
static PredicateExpression	gt(java.lang.Object rhs) The field is greater than the argument
static PredicateExpression	gte(java.lang.Object rhs) The field is greater than or equal to the argument
static PredicateExpression	in(java.lang.Object... rhs) The document field must exist in the list provided
static PredicateExpression	lt(java.lang.Object rhs) The field is less than the argument
static PredicateExpression	lte(java.lang.Object rhs) The field is less than or equal to the argument
static PredicateExpression	mod(java.lang.Long divisor, java.lang.Long remainder) Divisor and Remainder are both positive or negative integers.
static PredicateExpression	ne(java.lang.Object rhs) The field is not equal to the argument
static PredicateExpression	nin(java.lang.Object... rhs) The document field must not exist in the list provided
static PredicateExpression	regex(java.lang.String rhs) A regular expression pattern to match against the document field.
static PredicateExpression	size(java.lang.Long rhs) Special condition to match the length of an array field in a document.
java.lang.String	toString()
static PredicateExpression	type(Type rhs) The field has a given type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

lt

public static PredicateExpression lt(java.lang.Object rhs)

The field is less than the argument

Parameters:

rhs - The argument for the comparison

Returns:

PredicateExpression: $lt rhs

lte

public static PredicateExpression lte(java.lang.Object rhs)

The field is less than or equal to the argument

Parameters:

rhs - The argument for the comparison

Returns:

PredicateExpression: $lte rhs

eq

public static PredicateExpression eq(java.lang.Object rhs)

The field is equal to the argument

Parameters:

rhs - The argument for the comparison

Returns:

PredicateExpression: $eq rhs

ne

public static PredicateExpression ne(java.lang.Object rhs)

The field is not equal to the argument

Parameters:

rhs - The argument for the comparison

Returns:

PredicateExpression: $ne rhs

gte

public static PredicateExpression gte(java.lang.Object rhs)

The field is greater than or equal to the argument

Parameters:

rhs - The argument for the comparison

Returns:

PredicateExpression: $gte rhs

gt

public static PredicateExpression gt(java.lang.Object rhs)

The field is greater than the argument

Parameters:

rhs - The argument for the comparison

Returns:

PredicateExpression: $gt rhs

exists

public static PredicateExpression exists(boolean rhs)

The field exists or not, regardless of its value

Parameters:

rhs - The argument (true or false)

Returns:

PredicateExpression: $exists rhs

type

public static PredicateExpression type(Type rhs)

The field has a given type

Parameters:

rhs - The type

Returns:

PredicateExpression: $type rhs

in

public static PredicateExpression in(java.lang.Object... rhs)

The document field must exist in the list provided

Parameters:

rhs - The argument - one or more values

Returns:

PredicateExpression: $in rhs

nin

public static PredicateExpression nin(java.lang.Object... rhs)

The document field must not exist in the list provided

Parameters:

rhs - The argument - one or more values

Returns:

PredicateExpression: $nin rhs

size

public static PredicateExpression size(java.lang.Long rhs)

Special condition to match the length of an array field in a document. Non-array fields cannot match this condition

Parameters:

rhs - The length of the array

Returns:

PredicateExpression: $size rhs

mod

public static PredicateExpression mod(java.lang.Long divisor,
                                      java.lang.Long remainder)

Divisor and Remainder are both positive or negative integers. Non-integer values result in a 404 status. Matches documents where the expression (field % Divisor == Remainder) is true, and only when the document field is an integer

Parameters:

divisor - The divisor argument of the mod operation

remainder - The remainder argument of the mod operation

Returns:

PredicateExpression: $mod divisor remainder

regex

public static PredicateExpression regex(java.lang.String rhs)

A regular expression pattern to match against the document field. Matches only when the field is a string value and matches the supplied regular expression

Parameters:

rhs - The regular expression

Returns:

PredicateExpression: $regex rhs

all

public static PredicateExpression all(java.lang.Object... rhs)

Matches an array value if it contains all the elements of the argument array

Parameters:

rhs - The arguments

Returns:

PredicateExpression: $all rhs

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object