Interface IExpression

An interface representing an abstract expression that can act on a given piece of data

Namespace: Couchbase.Lite.Query

Assembly: Couchbase.Lite.dll

Syntax

public interface IExpression

Methods

Add(IExpression)

Mathematically adds the given expression to the current expression

Declaration

IExpression Add(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to add

Returns

Type	Description
IExpression	The expression representing the new operation

And(IExpression)

Logically "ands" the given expression with the current expression

Declaration

IExpression And(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to "and"

Returns

Type	Description
IExpression	The expression representing the new operation

Between(IExpression, IExpression)

Determines if the result is between the two given expressions

Declaration

IExpression Between(IExpression expression1, IExpression expression2)

Parameters

Type	Name	Description
IExpression	expression1	The expression to use as the first bound
IExpression	expression2	The expression to use as the second bound

Returns

Type	Description
IExpression	The expression representing the new operation

Collate(ICollation)

Collates the previous expression using the given collation instance (normally this is used directly after Property(String) when it is part of a Where(IExpression) or OrderBy(IOrdering[]))

Declaration

IExpression Collate(ICollation collation)

Parameters

Type	Name	Description
ICollation	collation	The collation instance to use when collating

Returns

Type	Description
IExpression	The expression representing the new operation

Divide(IExpression)

Matehematically divides the current and given expressions

Declaration

IExpression Divide(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to divide

Returns

Type	Description
IExpression	The expression representing the new operation

EqualTo(IExpression)

Returns an expression that will evaluate whether or not the given and current expression are equal

Declaration

IExpression EqualTo(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

GreaterThan(IExpression)

Returns an expression that will evaluate whether or not the given expression is greater than the current one

Declaration

IExpression GreaterThan(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

GreaterThanOrEqualTo(IExpression)

Returns an expression that will evaluate whether or not the given expression is greater than or equal to the current one

Declaration

IExpression GreaterThanOrEqualTo(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

In(IExpression[])

Returns an expression to test whether or not the given expression is contained in the given list of expressions

Declaration

IExpression In(params IExpression[] expressions)

Parameters

Type	Name	Description
IExpression[]	expressions	The list of expressions to check

Returns

Type	Description
IExpression	The expression representing the new operation

Is(IExpression)

Returns an expression to test whether or not the given expression is the same as the current current expression

Declaration

IExpression Is(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare to

Returns

Type	Description
IExpression	The expression representing the new operation

IsNot(IExpression)

Returns an expression to test whether or not the given expression is NOT the same as the current current expression

Declaration

IExpression IsNot(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare to

Returns

Type	Description
IExpression	The expression representing the new operation

IsNullOrMissing()

Gets an expression representing if the current expression is null or missing (i.e. does not have a value)

Declaration

IExpression IsNullOrMissing()

Returns

Type	Description
IExpression	The expression representing the new operation

LessThan(IExpression)

Returns an expression that will evaluate whether or not the given expression is less than the current one

Declaration

IExpression LessThan(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

LessThanOrEqualTo(IExpression)

Returns an expression that will evaluate whether or not the given expression is less than or equal to the current one

Declaration

IExpression LessThanOrEqualTo(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

Like(IExpression)

Returns an expression that will evaluate whether or not the given expression is "LIKE" the current one

Declaration

IExpression Like(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

Modulo(IExpression)

Returns an modulo math expression using the current and given expressions as operands

Declaration

IExpression Modulo(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to mod with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

Multiply(IExpression)

Returns a multiply expression using the current and given expressions as operands

Declaration

IExpression Multiply(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to multiply with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

NotEqualTo(IExpression)

Returns an expression that will evaluate whether or not the given and current expression are not equal

Declaration

IExpression NotEqualTo(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

NotNullOrMissing()

Gets an expression representing if the current expression is neither null nor missing (i.e. has a value)

Declaration

IExpression NotNullOrMissing()

Returns

Type	Description
IExpression	The expression representing the new operation

Or(IExpression)

Logically "ors" the given expression with the current expression

Declaration

IExpression Or(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to "and"

Returns

Type	Description
IExpression	The expression representing the new operation

Regex(IExpression)

Returns an expression that will evaluate whether or not the given expression regex matches the current one

Declaration

IExpression Regex(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to compare with the current one

Returns

Type	Description
IExpression	The expression representing the new operation

Subtract(IExpression)

Mathematically subtracts the given expression to the current expression

Declaration

IExpression Subtract(IExpression expression)

Parameters

Type	Name	Description
IExpression	expression	The expression to subtract

Returns

Type	Description
IExpression	The expression representing the new operation