com.couchbase.lite

Class Expression

java.lang.Object

com.couchbase.lite.Expression

public abstract class Expression
extends Object

An expression used for constructing a query statement.

Constructor Summary

Constructors

Constructor and Description
Expression()

Method Summary

Modifier and Type	Method and Description
Expression	add(Object expression) Create an add expression to add the given expression to the current expression
Expression	and(Object expression) Create a logical AND expression that performs logical AND operation with the current expression.
protected abstract Object	asJSON()
Expression	between(Object expression1, Object expression2) Create a between expression that evaluates whether or not the current expression is between the given expressions inclusively.
Expression	concat(Object expression) Create a concat expression to concatenate the current expression with the given expression.
Expression	divide(Object expression) Create a divide expression to divide the current expression by the given expression.
Expression	equalTo(Object expression) Create an equal to expression that evaluates whether or not the current expression is equal to the given expression.
Expression	greaterThan(Object expression) Create a greater than expression that evaluates whether or not the current expression is greater than the given expression.
Expression	greaterThanOrEqualTo(Object expression) Create a greater than or equal to expression that evaluates whether or not the current expression is greater than or equal to the given expression.
Expression	in(Object... expressions) Create an IN expression that evaluates whether or not the current expression is in the given expressions.
Expression	is(Object expression) Create an IS expression that evaluates whether or not the current expression is equal to the given expression.
Expression	isNot(Object expression) Create an IS NOT expression that evaluates whether or not the current expression is not equal to the given expression.
Expression	isNull() Create an IS NULL expression that evaluates whether or not the current expression is null.
Expression	lessThan(Object expression) Create a less than expression that evaluates whether or not the current expression is less than the given expression.
Expression	lessThanOrEqualTo(Object expression) Create a less than or equal to expression that evaluates whether or not the current expression is less than or equal to the given expression.
Expression	like(Object expression) Create a Like expression that evaluates whether or not the current expression is LIKE the given expression.
Expression	match(Object expression) Create a full text match expression that evaluates whether or not the current expression full text matches the given expression.
Expression	modulo(Object expression) Create a modulo expression to modulo the current expression by the given expression.
Expression	multiply(Object expression) Create a multiply expression to multiply the current expression by the given expression.
static Expression	negated(Object expression) Create a negated expression to represent the negated result of the given expression.
static Expression	not(Object expression) Create a negated expression to represent the negated result of the given expression.
Expression	notBetween(Object expression1, Object expression2) Create a NOT between expression that evaluates whether or not the current expression is not between the given expressions.
Expression	notEqualTo(Object expression) Create a NOT equal to expression that evaluates whether or not the current expression is not equal to the given expression.
Expression	notGreaterThan(Object expression) Create a NOT greater than expression that evaluates whether or not the current expression is not greater than the given expression.
Expression	notGreaterThanOrEqualTo(Object expression) Create a NOT greater than or equal to expression that evaluates whether or not the current expression is not greater than or equal to the given expression.
Expression	notIn(Object... expressions) Create a NOT IN expression that evaluates whether or not the current expression is not in the given expressions.
Expression	notLessThan(Object expression) Create a NOT less than expression that evaluates whether or not the current expression is not less than the given expression.
Expression	notLessThanOrEqualTo(Object expression) Create a NOT less than or equal to expression that evaluates whether or not the current expression is not less than or equal to the given expression.
Expression	notLike(Object expression) Create a NOT Like expression that evaluates whether or not the current expression is NOT LIKE the given expression.
Expression	notMatch(Object expression) Create a full text NOT match expression that evaluates whether or not the current expression doesn't full text match the given expression.
Expression	notNull() Create an IS NOT NULL expression that evaluates whether or not the current expression is not null.
Expression	notRegex(Object expression) Create a NOT regex match expression that evaluates whether or not the current expression not regex matches the given expression.
Expression	or(Object expression) Create a logical OR expression that performs logical OR operation with the current expression.
static Expression	property(String property) Create a property expression representing the value of the given property.
Expression	regex(Object expression) Create a regex match expression that evaluates whether or not the current expression regex matches the given expression.
Expression	subtract(Object expression) Create a subtract expression to subtract the given expression from the current expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

Expression

public Expression()

Method Detail

property

public static Expression property(String property)

Create a property expression representing the value of the given property.

Parameters:

property - the name of the property in the form of a key path.

Returns:

a property expression.

negated

public static Expression negated(Object expression)

Create a negated expression to represent the negated result of the given expression.

Parameters:

expression - the expression to be negated.

Returns:

a negated expression.

not

public static Expression not(Object expression)

Create a negated expression to represent the negated result of the given expression.

Parameters:

expression - the expression to be negated.

Returns:

a negated expression.

concat

public Expression concat(Object expression)

Create a concat expression to concatenate the current expression with the given expression.

Parameters:

expression - the expression to concatenate with.

Returns:

a concat expression.

multiply

public Expression multiply(Object expression)

Create a multiply expression to multiply the current expression by the given expression.

Parameters:

expression - the expression to multiply by.

Returns:

a multiply expression.

divide

public Expression divide(Object expression)

Create a divide expression to divide the current expression by the given expression.

Parameters:

expression - the expression to divide by.

Returns:

a divide expression.

modulo

public Expression modulo(Object expression)

Create a modulo expression to modulo the current expression by the given expression.

Parameters:

expression - the expression to modulo by.

Returns:

a modulo expression.

add

public Expression add(Object expression)

Create an add expression to add the given expression to the current expression

Parameters:

expression - an expression to add to the current expression.

Returns:

an add expression.

subtract

public Expression subtract(Object expression)

Create a subtract expression to subtract the given expression from the current expression.

Parameters:

expression - an expression to subtract from the current expression.

Returns:

a substract expression.

lessThan

public Expression lessThan(Object expression)

Create a less than expression that evaluates whether or not the current expression is less than the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a less than expression.

notLessThan

public Expression notLessThan(Object expression)

Create a NOT less than expression that evaluates whether or not the current expression is not less than the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a NOT less than expression.

lessThanOrEqualTo

public Expression lessThanOrEqualTo(Object expression)

Create a less than or equal to expression that evaluates whether or not the current expression is less than or equal to the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a less than or equal to expression.

notLessThanOrEqualTo

public Expression notLessThanOrEqualTo(Object expression)

Create a NOT less than or equal to expression that evaluates whether or not the current expression is not less than or equal to the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a NOT less than or equal to expression.

greaterThan

public Expression greaterThan(Object expression)

Create a greater than expression that evaluates whether or not the current expression is greater than the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a greater than expression.

notGreaterThan

public Expression notGreaterThan(Object expression)

Create a NOT greater than expression that evaluates whether or not the current expression is not greater than the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a NOT greater than expression.

greaterThanOrEqualTo

public Expression greaterThanOrEqualTo(Object expression)

Create a greater than or equal to expression that evaluates whether or not the current expression is greater than or equal to the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a greater than or equal to expression.

notGreaterThanOrEqualTo

public Expression notGreaterThanOrEqualTo(Object expression)

Create a NOT greater than or equal to expression that evaluates whether or not the current expression is not greater than or equal to the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a NOT greater than or equal to expression.

equalTo

public Expression equalTo(Object expression)

Create an equal to expression that evaluates whether or not the current expression is equal to the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

an equal to expression.

notEqualTo

public Expression notEqualTo(Object expression)

Create a NOT equal to expression that evaluates whether or not the current expression is not equal to the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a NOT equal to exprssion.

and

public Expression and(Object expression)

Create a logical AND expression that performs logical AND operation with the current expression.

Parameters:

expression - the expression to AND with the current expression.

Returns:

a logical AND expression.

or

public Expression or(Object expression)

Create a logical OR expression that performs logical OR operation with the current expression.

Parameters:

expression - the expression to OR with the current expression.

Returns:

a logical OR exprssion.

like

public Expression like(Object expression)

Create a Like expression that evaluates whether or not the current expression is LIKE the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a Like expression.

notLike

public Expression notLike(Object expression)

Create a NOT Like expression that evaluates whether or not the current expression is NOT LIKE the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a NOT Like expression.

regex

public Expression regex(Object expression)

Create a regex match expression that evaluates whether or not the current expression regex matches the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a regex match expression.

notRegex

public Expression notRegex(Object expression)

Create a NOT regex match expression that evaluates whether or not the current expression not regex matches the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a NOT regex match expression.

match

public Expression match(Object expression)

Create a full text match expression that evaluates whether or not the current expression full text matches the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a full text match expression.

notMatch

public Expression notMatch(Object expression)

Create a full text NOT match expression that evaluates whether or not the current expression doesn't full text match the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

a full text NOT match expression.

isNull

public Expression isNull()

Create an IS NULL expression that evaluates whether or not the current expression is null.

Returns:

an IS NULL expression.

notNull

public Expression notNull()

Create an IS NOT NULL expression that evaluates whether or not the current expression is not null.

Returns:

an IS NOT NULL expression.

is

public Expression is(Object expression)

Create an IS expression that evaluates whether or not the current expression is equal to the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

an IS expression.

isNot

public Expression isNot(Object expression)

Create an IS NOT expression that evaluates whether or not the current expression is not equal to the given expression.

Parameters:

expression - the expression to compare with the current expression.

Returns:

an IS NOT expression.

between

public Expression between(Object expression1,
                          Object expression2)

Create a between expression that evaluates whether or not the current expression is between the given expressions inclusively.

Parameters:

expression1 - the inclusive lower bound expression.

expression2 - the inclusive upper bound expression.

Returns:

a between expression.

notBetween

public Expression notBetween(Object expression1,
                             Object expression2)

Create a NOT between expression that evaluates whether or not the current expression is not between the given expressions.

Parameters:

expression1 - the lower bound expression.

expression2 - the upper bound expression.

Returns:

a NOT between expression.

in

public Expression in(Object... expressions)

Create an IN expression that evaluates whether or not the current expression is in the given expressions.

Parameters:

expressions - the expression array to evaluate with.

Returns:

an IN expression.

notIn

public Expression notIn(Object... expressions)

Create a NOT IN expression that evaluates whether or not the current expression is not in the given expressions.

Parameters:

expressions - the expression array to evaluate with.

Returns:

a NOT IN expression.

asJSON

protected abstract Object asJSON()