com.solarmetric.rd.kodo.query
Interface ExpressionFactory

All Known Implementing Classes:

InMemoryExpressionFactory, JDBCExpressionFactory

public interface ExpressionFactory

The ExpressionFactory must be implemented by a particular runtime to form Expressions in its native query language.

Method Summary

com.solarmetric.rd.kodo.query.Value	add(com.solarmetric.rd.kodo.query.Value val1, com.solarmetric.rd.kodo.query.Value val2) Return a value representing the two values added together.
com.solarmetric.rd.kodo.query.Expression	and(com.solarmetric.rd.kodo.query.Expression exp1, com.solarmetric.rd.kodo.query.Expression exp2) Return the two expressions AND'd together.
com.solarmetric.rd.kodo.query.Expression	bindKeyVariable(com.solarmetric.rd.kodo.query.Value var, com.solarmetric.rd.kodo.query.Value val) Bind the given variable to the key set of the given map value.
com.solarmetric.rd.kodo.query.Expression	bindValueVariable(com.solarmetric.rd.kodo.query.Value var, com.solarmetric.rd.kodo.query.Value val) Bind the given variable to the value set of the given map value.
com.solarmetric.rd.kodo.query.Expression	bindVariable(com.solarmetric.rd.kodo.query.Value var, com.solarmetric.rd.kodo.query.Value val) Bind the given variable to the given collection value.
com.solarmetric.rd.kodo.query.Value	cast(com.solarmetric.rd.kodo.query.Value val, java.lang.Class cls) Cast the value to the given class.
com.solarmetric.rd.kodo.query.Expression	contains(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	containsKey(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	containsValue(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Value	divide(com.solarmetric.rd.kodo.query.Value val1, com.solarmetric.rd.kodo.query.Value val2) Return a value representing the first value divided by the first one.
com.solarmetric.rd.kodo.query.Expression	emptyExpression() Return a blank expression; this is used when the filter is empty.
com.solarmetric.rd.kodo.query.Expression	endsWith(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	equal(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	extensionExpression(com.solarmetric.rd.kodo.query.FilterListener listener, com.solarmetric.rd.kodo.query.Value target, com.solarmetric.rd.kodo.query.Value arg) Return an expression formed by evaluating the given extension.
com.solarmetric.rd.kodo.query.Value	getNull() Return a value representing null.
com.solarmetric.rd.kodo.query.Value	getThis() Return a value representing this.
com.solarmetric.rd.kodo.query.Expression	greaterThan(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	greaterThanEqual(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	isEmpty(com.solarmetric.rd.kodo.query.Value v1) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	lessThan(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	lessThanEqual(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Value	mod(com.solarmetric.rd.kodo.query.Value val1, com.solarmetric.rd.kodo.query.Value val2) Return a value representing the first value mod'd by the second one.
com.solarmetric.rd.kodo.query.Value	multiply(com.solarmetric.rd.kodo.query.Value val1, com.solarmetric.rd.kodo.query.Value val2) Return a value representing the two values multiplied together.
com.solarmetric.rd.kodo.query.Value	newBoundVariable(java.lang.String name, java.lang.Class type) This method will be called only once per variable bound in a contains clause, and the returned value will be reused for any further instances of the variable in subexpression of the filter string.
com.solarmetric.rd.kodo.query.Value	newConstant(java.lang.Object val) Return a value representing the given constant, which will be a Number, String, or Boolean instance.
com.solarmetric.rd.kodo.query.Value	newExtension(com.solarmetric.rd.kodo.query.FilterListener listener, com.solarmetric.rd.kodo.query.Value target, com.solarmetric.rd.kodo.query.Value arg) Return the value of the given extension.
com.solarmetric.rd.kodo.query.Value	newParameter(java.lang.String name, java.lang.Class type) Return a value representing a parameter for the given value.
com.solarmetric.rd.kodo.query.Path	newPath() Return a value representing a path which will consist of a chain of 1 or more field names starting in the namespace of the candidate class.
com.solarmetric.rd.kodo.query.Path	newPath(com.solarmetric.rd.kodo.query.Value val) Return a value representing a path which will consist of a chain of 1 or more field names starting in the namespace of the given value.
com.solarmetric.rd.kodo.query.Value	newUnboundVariable(java.lang.String name, java.lang.Class type) Return an unbound variable.
com.solarmetric.rd.kodo.query.Expression	not(com.solarmetric.rd.kodo.query.Expression exp) Return the inverse of this expression.
com.solarmetric.rd.kodo.query.Expression	notEqual(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Expression	or(com.solarmetric.rd.kodo.query.Expression exp1, com.solarmetric.rd.kodo.query.Expression exp2) Return the two expressions OR'd together.
com.solarmetric.rd.kodo.query.Expression	orderBy(com.solarmetric.rd.kodo.query.Expression exp, com.solarmetric.rd.kodo.query.Value val, boolean ascending) Return an expression representing this one, ordered by the given value.
com.solarmetric.rd.kodo.query.Expression	startsWith(com.solarmetric.rd.kodo.query.Value v1, com.solarmetric.rd.kodo.query.Value v2) Return an expression representing the given condition.
com.solarmetric.rd.kodo.query.Value	subtract(com.solarmetric.rd.kodo.query.Value val1, com.solarmetric.rd.kodo.query.Value val2) Return a value representing the second value subtracted from the first.

Method Detail

emptyExpression

public com.solarmetric.rd.kodo.query.Expression emptyExpression()

Return a blank expression; this is used when the filter is empty.

equal

public com.solarmetric.rd.kodo.query.Expression equal(com.solarmetric.rd.kodo.query.Value v1,
                                                      com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

notEqual

public com.solarmetric.rd.kodo.query.Expression notEqual(com.solarmetric.rd.kodo.query.Value v1,
                                                         com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

lessThan

public com.solarmetric.rd.kodo.query.Expression lessThan(com.solarmetric.rd.kodo.query.Value v1,
                                                         com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

greaterThan

public com.solarmetric.rd.kodo.query.Expression greaterThan(com.solarmetric.rd.kodo.query.Value v1,
                                                            com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

lessThanEqual

public com.solarmetric.rd.kodo.query.Expression lessThanEqual(com.solarmetric.rd.kodo.query.Value v1,
                                                              com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

greaterThanEqual

public com.solarmetric.rd.kodo.query.Expression greaterThanEqual(com.solarmetric.rd.kodo.query.Value v1,
                                                                 com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

isEmpty

public com.solarmetric.rd.kodo.query.Expression isEmpty(com.solarmetric.rd.kodo.query.Value v1)

Return an expression representing the given condition.

contains

public com.solarmetric.rd.kodo.query.Expression contains(com.solarmetric.rd.kodo.query.Value v1,
                                                         com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

containsKey

public com.solarmetric.rd.kodo.query.Expression containsKey(com.solarmetric.rd.kodo.query.Value v1,
                                                            com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

containsValue

public com.solarmetric.rd.kodo.query.Expression containsValue(com.solarmetric.rd.kodo.query.Value v1,
                                                              com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

startsWith

public com.solarmetric.rd.kodo.query.Expression startsWith(com.solarmetric.rd.kodo.query.Value v1,
                                                           com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

endsWith

public com.solarmetric.rd.kodo.query.Expression endsWith(com.solarmetric.rd.kodo.query.Value v1,
                                                         com.solarmetric.rd.kodo.query.Value v2)

Return an expression representing the given condition.

and

public com.solarmetric.rd.kodo.query.Expression and(com.solarmetric.rd.kodo.query.Expression exp1,
                                                    com.solarmetric.rd.kodo.query.Expression exp2)

Return the two expressions AND'd together.

or

public com.solarmetric.rd.kodo.query.Expression or(com.solarmetric.rd.kodo.query.Expression exp1,
                                                   com.solarmetric.rd.kodo.query.Expression exp2)

Return the two expressions OR'd together.

not

public com.solarmetric.rd.kodo.query.Expression not(com.solarmetric.rd.kodo.query.Expression exp)

Return the inverse of this expression.

orderBy

public com.solarmetric.rd.kodo.query.Expression orderBy(com.solarmetric.rd.kodo.query.Expression exp,
                                                        com.solarmetric.rd.kodo.query.Value val,
                                                        boolean ascending)

Return an expression representing this one, ordered by the given value. Multiple calls to this method might be made; the resulting Expression should order by all paths in the proper order.

extensionExpression

public com.solarmetric.rd.kodo.query.Expression extensionExpression(com.solarmetric.rd.kodo.query.FilterListener listener,
                                                                    com.solarmetric.rd.kodo.query.Value target,
                                                                    com.solarmetric.rd.kodo.query.Value arg)

Return an expression formed by evaluating the given extension.

bindVariable

public com.solarmetric.rd.kodo.query.Expression bindVariable(com.solarmetric.rd.kodo.query.Value var,
                                                             com.solarmetric.rd.kodo.query.Value val)

Bind the given variable to the given collection value.

bindKeyVariable

public com.solarmetric.rd.kodo.query.Expression bindKeyVariable(com.solarmetric.rd.kodo.query.Value var,
                                                                com.solarmetric.rd.kodo.query.Value val)

Bind the given variable to the key set of the given map value.

bindValueVariable

public com.solarmetric.rd.kodo.query.Expression bindValueVariable(com.solarmetric.rd.kodo.query.Value var,
                                                                  com.solarmetric.rd.kodo.query.Value val)

Bind the given variable to the value set of the given map value.

newPath

public com.solarmetric.rd.kodo.query.Path newPath()

Return a value representing a path which will consist of a chain of 1 or more field names starting in the namespace of the candidate class.

Example: parent.address.city

newPath

public com.solarmetric.rd.kodo.query.Path newPath(com.solarmetric.rd.kodo.query.Value val)

Return a value representing a path which will consist of a chain of 1 or more field names starting in the namespace of the given value.

Example: var.address.city

newConstant

public com.solarmetric.rd.kodo.query.Value newConstant(java.lang.Object val)

Return a value representing the given constant, which will be a Number, String, or Boolean instance.

getThis

public com.solarmetric.rd.kodo.query.Value getThis()

Return a value representing this.

getNull

public com.solarmetric.rd.kodo.query.Value getNull()

Return a value representing null.

newParameter

public com.solarmetric.rd.kodo.query.Value newParameter(java.lang.String name,
                                                        java.lang.Class type)

Return a value representing a parameter for the given value.

newExtension

public com.solarmetric.rd.kodo.query.Value newExtension(com.solarmetric.rd.kodo.query.FilterListener listener,
                                                        com.solarmetric.rd.kodo.query.Value target,
                                                        com.solarmetric.rd.kodo.query.Value arg)

Return the value of the given extension.

newUnboundVariable

public com.solarmetric.rd.kodo.query.Value newUnboundVariable(java.lang.String name,
                                                              java.lang.Class type)

Return an unbound variable. This method will only be called once for a given named unbound variable.

newBoundVariable

public com.solarmetric.rd.kodo.query.Value newBoundVariable(java.lang.String name,
                                                            java.lang.Class type)

This method will be called only once per variable bound in a contains clause, and the returned value will be reused for any further instances of the variable in subexpression of the filter string.

cast

public com.solarmetric.rd.kodo.query.Value cast(com.solarmetric.rd.kodo.query.Value val,
                                                java.lang.Class cls)

Cast the value to the given class.

add

public com.solarmetric.rd.kodo.query.Value add(com.solarmetric.rd.kodo.query.Value val1,
                                               com.solarmetric.rd.kodo.query.Value val2)

Return a value representing the two values added together.

subtract

public com.solarmetric.rd.kodo.query.Value subtract(com.solarmetric.rd.kodo.query.Value val1,
                                                    com.solarmetric.rd.kodo.query.Value val2)

Return a value representing the second value subtracted from the first.

multiply

public com.solarmetric.rd.kodo.query.Value multiply(com.solarmetric.rd.kodo.query.Value val1,
                                                    com.solarmetric.rd.kodo.query.Value val2)

Return a value representing the two values multiplied together.

divide

public com.solarmetric.rd.kodo.query.Value divide(com.solarmetric.rd.kodo.query.Value val1,
                                                  com.solarmetric.rd.kodo.query.Value val2)

Return a value representing the first value divided by the first one.

mod

public com.solarmetric.rd.kodo.query.Value mod(com.solarmetric.rd.kodo.query.Value val1,
                                               com.solarmetric.rd.kodo.query.Value val2)

Return a value representing the first value mod'd by the second one.