Expression (Couchbase Lite 2.0.0-299)

java.lang.Object
- com.couchbase.lite.Expression

Direct Known Subclasses:

MetaExpression, PropertyExpression, VariableExpression
```
public abstract class Expression
extends Object
```
An expression used for constructing a query statement.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Expression`	`add(Expression expression)` Create an add expression to add the given expression to the current expression
`static PropertyExpression`	`all()` Creates a * expression to express all properties
`Expression`	`and(Expression expression)` Create a logical AND expression that performs logical AND operation with the current expression.
`Expression`	`between(Expression expression1, Expression expression2)` Create a between expression that evaluates whether or not the current expression is between the given expressions inclusively.
`static Expression`	`booleanValue(boolean value)` Create value expression with given boolean value
`Expression`	`collate(Collation collation)` Creates a Collate expression with the given Collation specification.
`static Expression`	`date(Date value)` Create value expression with given Date value
`Expression`	`divide(Expression expression)` Create a divide expression to divide the current expression by the given expression.
`static Expression`	`doubleValue(double value)` Create value expression with given double value
`Expression`	`equalTo(Expression expression)` Create an equal to expression that evaluates whether or not the current expression is equal to the given expression.
`static Expression`	`floatValue(float value)` Create value expression with given float value
`Expression`	`greaterThan(Expression expression)` Create a greater than expression that evaluates whether or not the current expression is greater than the given expression.
`Expression`	`greaterThanOrEqualTo(Expression 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(Expression... expressions)` Create an IN expression that evaluates whether or not the current expression is in the given expressions.
`static Expression`	`intValue(int value)` Create value expression with given integer value
`Expression`	`is(Expression expression)` Create an IS expression that evaluates whether or not the current expression is equal to the given expression.
`Expression`	`isNot(Expression expression)` Create an IS NOT expression that evaluates whether or not the current expression is not equal to the given expression.
`Expression`	`isNullOrMissing()` Creates an IS NULL OR MISSING expression that evaluates whether or not the current expression is null or missing.
`Expression`	`lessThan(Expression expression)` Create a less than expression that evaluates whether or not the current expression is less than the given expression.
`Expression`	`lessThanOrEqualTo(Expression 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(Expression expression)` Create a Like expression that evaluates whether or not the current expression is LIKE the given expression.
`static Expression`	`longValue(long value)` Create value expression with given long value
`Expression`	`modulo(Expression expression)` Create a modulo expression to modulo the current expression by the given expression.
`Expression`	`multiply(Expression expression)` Create a multiply expression to multiply the current expression by the given expression.
`static Expression`	`negated(Expression expression)` Create a negated expression to represent the negated result of the given expression.
`static Expression`	`not(Expression expression)` Create a negated expression to represent the negated result of the given expression.
`Expression`	`notEqualTo(Expression expression)` Create a NOT equal to expression that evaluates whether or not the current expression is not equal to the given expression.
`Expression`	`notNullOrMissing()` Creates an IS NOT NULL OR MISSING expression that evaluates whether or not the current expression is NOT null or missing.
`static Expression`	`number(Number value)` Create value expression with given Number value
`Expression`	`or(Expression expression)` Create a logical OR expression that performs logical OR operation with the current expression.
`static Expression`	`parameter(String name)` Creates a parameter expression with the given parameter name.
`static PropertyExpression`	`property(String property)` Create a property expression representing the value of the given property.
`Expression`	`regex(Expression expression)` Create a regex match expression that evaluates whether or not the current expression regex matches the given expression.
`static Expression`	`string(String value)` Create value expression with given String value
`Expression`	`subtract(Expression expression)` Create a subtract expression to subtract the given expression from the current expression.
`String`	`toString()`
`static Expression`	`value(Object value)` Create value expression with given value

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

- Method Detail
  - value
```
public static Expression value(Object value)
```
    Create value expression with given value
    
    Parameters:
    
    value - the value
    
    Returns:
    
    the value expression
  - string
```
public static Expression string(String value)
```
    Create value expression with given String value
    
    Parameters:
    
    value - the String value
    
    Returns:
    
    the value expression
  - number
```
public static Expression number(Number value)
```
    Create value expression with given Number value
    
    Parameters:
    
    value - the Number value
    
    Returns:
    
    the value expression
  - intValue
```
public static Expression intValue(int value)
```
    Create value expression with given integer value
    
    Parameters:
    
    value - the integer value
    
    Returns:
    
    the value expression
  - longValue
```
public static Expression longValue(long value)
```
    Create value expression with given long value
    
    Parameters:
    
    value - the long value
    
    Returns:
    
    the value expression
  - floatValue
```
public static Expression floatValue(float value)
```
    Create value expression with given float value
    
    Parameters:
    
    value - the float value
    
    Returns:
    
    the value expression
  - doubleValue
```
public static Expression doubleValue(double value)
```
    Create value expression with given double value
    
    Parameters:
    
    value - the double value
    
    Returns:
    
    the value expression
  - booleanValue
```
public static Expression booleanValue(boolean value)
```
    Create value expression with given boolean value
    
    Parameters:
    
    value - the boolean value
    
    Returns:
    
    the value expression
  - date
```
public static Expression date(Date value)
```
    Create value expression with given Date value
    
    Parameters:
    
    value - the Date value
    
    Returns:
    
    the value expression
  - all
```
public static PropertyExpression all()
```
    Creates a * expression to express all properties
    
    Returns:
    
    a property expression.
  - property
```
public static PropertyExpression 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.
  - parameter
```
public static Expression parameter(String name)
```
    Creates a parameter expression with the given parameter name.
    
    Parameters:
    
    name - The parameter name
    
    Returns:
    
    A parameter expression.
  - negated
```
public static Expression negated(Expression 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(Expression 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.
  - multiply
```
public Expression multiply(Expression 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(Expression 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(Expression 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(Expression 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(Expression 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(Expression 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.
  - lessThanOrEqualTo
```
public Expression lessThanOrEqualTo(Expression 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.
  - greaterThan
```
public Expression greaterThan(Expression 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.
  - greaterThanOrEqualTo
```
public Expression greaterThanOrEqualTo(Expression 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.
  - equalTo
```
public Expression equalTo(Expression 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(Expression 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(Expression 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(Expression 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(Expression 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.
  - regex
```
public Expression regex(Expression 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.
  - is
```
public Expression is(Expression 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(Expression 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(Expression expression1,
                          Expression 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.
  - isNullOrMissing
```
public Expression isNullOrMissing()
```
    Creates an IS NULL OR MISSING expression that evaluates whether or not the current expression is null or missing.
    
    Returns:
    
    An IS NULL expression.
  - notNullOrMissing
```
public Expression notNullOrMissing()
```
    Creates an IS NOT NULL OR MISSING expression that evaluates whether or not the current expression is NOT null or missing.
    
    Returns:
    
    An IS NOT NULL expression.
  - collate
```
public Expression collate(Collation collation)
```
    Creates a Collate expression with the given Collation specification. Commonly the collate expression is used in the Order BY clause or the string comparison 　expression (e.g. equalTo or lessThan) to specify how the two strings are　compared.
    
    Parameters:
    
    collation - The collation object.
    
    Returns:
    
    A Collate expression.
  - in
```
public Expression in(Expression... 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.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Expression

Method Summary

Methods inherited from class java.lang.Object

Method Detail

value

string

number

intValue

longValue

floatValue

doubleValue

booleanValue

date

all

property

parameter

negated

not

multiply

divide

modulo

add

subtract

lessThan

lessThanOrEqualTo

greaterThan

greaterThanOrEqualTo

equalTo

notEqualTo

and

or

like

regex

is

isNot

between

isNullOrMissing

notNullOrMissing

collate

in

toString