com.cloudant.client.api.query

Class Expression

java.lang.Object

com.cloudant.client.api.query.Expression

All Implemented Interfaces:

Selector

public class Expression
extends java.lang.Object
implements Selector

Expressions are used to evaluate true/false criteria to select documents. For example, an expression to select documents where the field "widget_count" is equal to 5 would be constructed as follows

 
 Expression e = Expression.eq("widget_count", 5);
 
 

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

lt

public static Expression lt(java.lang.String lhs,
                            java.lang.Object rhs)

The field is less than the argument

Parameters:

lhs - The field to compare

rhs - The argument for the comparison

Returns:

Expression: lhs $lt rhs

lte

public static Expression lte(java.lang.String lhs,
                             java.lang.Object rhs)

The field is less than or equal to the argument

Parameters:

lhs - The field to compare

rhs - The argument for the comparison

Returns:

Expression: lhs $lte rhs

eq

public static Expression eq(java.lang.String lhs,
                            java.lang.Object rhs)

The field is equal to the argument

Parameters:

lhs - The field to compare

rhs - The argument for the comparison

Returns:

Expression: lhs $eq rhs

ne

public static Expression ne(java.lang.String lhs,
                            java.lang.Object rhs)

The field is not equal to the argument

Parameters:

lhs - The field to compare

rhs - The argument for the comparison

Returns:

Expression: lhs $ne rhs

gte

public static Expression gte(java.lang.String lhs,
                             java.lang.Object rhs)

The field is greater than or equal to the argument

Parameters:

lhs - The field to compare

rhs - The argument for the comparison

Returns:

Expression: lhs $gte rhs

gt

public static Expression gt(java.lang.String lhs,
                            java.lang.Object rhs)

The field is greater than the argument

Parameters:

lhs - The field to compare

rhs - The argument for the comparison

Returns:

Expression: lhs $gt rhs

exists

public static Expression exists(java.lang.String lhs,
                                boolean rhs)

Check whether the field exists or not, regardless of its value

Parameters:

lhs - The field to check

rhs - The argument (true or false)

Returns:

Expression: lhs $exists rhs

type

public static Expression type(java.lang.String lhs,
                              Type rhs)

Check the document field's type and object

Parameters:

lhs - The field to check

rhs - The type

Returns:

Expression: lhs $type rhs

in

public static Expression in(java.lang.String lhs,
                            java.lang.Object... rhs)

The document field must exist in the list provided

Parameters:

lhs - The field to check

rhs - The argument - one or more values

Returns:

Expression: lhs $in rhs

nin

public static Expression nin(java.lang.String lhs,
                             java.lang.Object... rhs)

The document field must not exist in the list provided

Parameters:

lhs - The field to check

rhs - The argument - one or more values

Returns:

Expression: lhs $nin rhs

size

public static Expression size(java.lang.String lhs,
                              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:

lhs - The field to check

rhs - The length of the array

Returns:

Expression: lhs $size rhs

mod

public static Expression mod(java.lang.String lhs,
                             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:

lhs - The field to check

divisor - The divisor argument of the mod operation

remainder - The remainder argument of the mod operation

Returns:

Expression: lhs $mod divisor remainder

regex

public static Expression regex(java.lang.String lhs,
                               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:

lhs - The field to match

rhs - The regular expression

Returns:

Expression: lhs $regex rhs

all

public static Expression all(java.lang.String lhs,
                             java.lang.Object... rhs)

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

Parameters:

lhs - The field to match

rhs - The arguments

Returns:

Expression: lhs $all rhs

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object