com.softwareag.eda.estore.query.api.builder

Class ExpressionBuilder

java.lang.Object

com.softwareag.eda.estore.query.api.builder.ExpressionBuilder

public final class ExpressionBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ExpressionBuilder()

Method Summary

Modifier and Type	Method and Description
ExpressionBuilder	and() Adds an AND operator to the current query expression.
ExpressionBuilder	and(ExpressionBuilder subexpression) Adds an AND operator to the current query expression.
ExpressionBuilder	between(ExpressionBuilder subexpression) Create a between expression using the specified sub-expression.
ExpressionBuilder	between(java.lang.String property, java.lang.Double lower, java.lang.Double upper, boolean inclusive) Add a between expression for the given Event property and double precision floating point range.
ExpressionBuilder	between(java.lang.String property, java.lang.Float lower, java.lang.Float upper, boolean inclusive) Add a between expression for the given Event property and floating point range.
ExpressionBuilder	between(java.lang.String property, java.lang.Integer lower, java.lang.Integer upper, boolean inclusive) Add a between expression for the given Event property and integer range.
ExpressionBuilder	between(java.lang.String property, java.lang.Long lower, java.lang.Long upper, boolean inclusive) Add a between expression for the given Event property and long integer range.
ExpressionBuilder	between(java.lang.String property, java.lang.String lower, java.lang.String upper, boolean inclusive) Add a between expression for the given Event property and string range.
ExpressionBuilder	between(java.lang.String property, java.sql.Timestamp lower, java.sql.Timestamp upper, boolean inclusive) Add a between expression for the given Event property and timestamp range.
java.lang.StringBuilder	getExpression()
ExpressionBuilder	or() Adds an OR operator to the current query expression.
ExpressionBuilder	or(ExpressionBuilder subexpression) Adds an OR operator to the current query expression.
ExpressionBuilder	simple(ExpressionBuilder subexpression) Add a simple expression using the specified sub-expression.
ExpressionBuilder	simple(java.lang.String property, Op operation, java.lang.Double operand) Add a simple expression to the current expression.
ExpressionBuilder	simple(java.lang.String property, Op operation, java.lang.Float operand) Add a simple expression to the current expression.
ExpressionBuilder	simple(java.lang.String property, Op operation, java.lang.Integer operand) Add a simple expression to the current expression.
ExpressionBuilder	simple(java.lang.String property, Op operation, java.lang.Long operand) Add a simple expression to the current expression.
ExpressionBuilder	simple(java.lang.String property, Op operation, java.lang.String operand) Add a simple expression to the current expression.
ExpressionBuilder	simple(java.lang.String property, Op operation, java.sql.Timestamp operand) Add a simple expression to the current expression.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExpressionBuilder

public ExpressionBuilder()

Method Detail

simple

public ExpressionBuilder simple(java.lang.String property,
                                Op operation,
                                java.lang.String operand)

Add a simple expression to the current expression. The method takes and Event property name, the operation to be used in the evaluation and the value to against which the property is compared. This simple method is used to evaluate string comparisons.

Parameters:

property - The Event property to compare

operation - The operation used for the comparison.

operand - The value against which the property is compared.

Returns:

A reference to this query builder instance to enable method chaining

simple

public ExpressionBuilder simple(java.lang.String property,
                                Op operation,
                                java.lang.Integer operand)

Add a simple expression to the current expression. The method takes and Event property name, the operation to be used in the evaluation and the value to against which the property is compared. This simple method is used to evaluate integer comparisons.

Parameters:

property - The Event property to compare

operation - The operation used for the comparison.

operand - The value against which the property is compared.

Returns:

A reference to this query builder instance to enable method chaining

simple

public ExpressionBuilder simple(java.lang.String property,
                                Op operation,
                                java.lang.Long operand)

Add a simple expression to the current expression. The method takes and Event property name, the operation to be used in the evaluation and the value to against which the property is compared. This simple method is used to evaluate long integer comparisons.

Parameters:

property - The Event property to compare

operation - The operation used for the comparison.

operand - The value against which the property is compared.

Returns:

A reference to this query builder instance to enable method chaining

simple

public ExpressionBuilder simple(java.lang.String property,
                                Op operation,
                                java.lang.Float operand)

Add a simple expression to the current expression. The method takes and Event property name, the operation to be used in the evaluation and the value to against which the property is compared. This simple method is used to evaluate floating point comparisons.

Parameters:

property - The Event property to compare

operation - The operation used for the comparison.

operand - The value against which the property is compared.

Returns:

A reference to this query builder instance to enable method chaining

simple

public ExpressionBuilder simple(java.lang.String property,
                                Op operation,
                                java.lang.Double operand)

Add a simple expression to the current expression. The method takes and Event property name, the operation to be used in the evaluation and the value to against which the property is compared. This simple method is used to evaluate double precision floating point comparisons.

Parameters:

property - The Event property to compare

operation - The operation used for the comparison.

operand - The value against which the property is compared.

Returns:

A reference to this query builder instance to enable method chaining

simple

public ExpressionBuilder simple(java.lang.String property,
                                Op operation,
                                java.sql.Timestamp operand)

Add a simple expression to the current expression. The method takes and Event property name, the operation to be used in the evaluation and the value to against which the property is compared. This simple method is used to evaluate timestamp comparisons.

Parameters:

property - The Event property to compare

operation - The operation used for the comparison.

operand - The value against which the property is compared.

Returns:

A reference to this query builder instance to enable method chaining

simple

public ExpressionBuilder simple(ExpressionBuilder subexpression)

Add a simple expression using the specified sub-expression. Sub-expressions are added to the expression and treated as having explicit precedence. The sub-expression will be wrapped between left and right parenthesis. Explicit precedence for the expression can be controlled through the use of these sub-expressions.

Parameters:

subexpression - The builder used to create the sub-expression.

Returns:

A reference to this query builder instance to enable method chaining

between

public ExpressionBuilder between(java.lang.String property,
                                 java.lang.String lower,
                                 java.lang.String upper,
                                 boolean inclusive)

Add a between expression for the given Event property and string range. The lower and upper values of the range are specified as well as a boolean indicating that the comparison should be inclusive or exclusive of these values.

Parameters:

property - The event property to be evaluated in the expression.

lower - The lower bounds of the expression.

upper - The upper bounds of the expression.

inclusive - A boolean indicating the range is inclusive.

Returns:

A reference to this query builder instance to enable method chaining

between

public ExpressionBuilder between(java.lang.String property,
                                 java.lang.Integer lower,
                                 java.lang.Integer upper,
                                 boolean inclusive)

Add a between expression for the given Event property and integer range. The lower and upper values of the range are specified as well as a boolean indicating that the comparison should be inclusive or exclusive of these values.

Parameters:

property - The event property to be evaluated in the expression.

lower - The lower bounds of the expression.

upper - The upper bounds of the expression.

inclusive - A boolean indicating the range is inclusive.

Returns:

A reference to this query builder instance to enable method chaining

between

public ExpressionBuilder between(java.lang.String property,
                                 java.lang.Long lower,
                                 java.lang.Long upper,
                                 boolean inclusive)

Add a between expression for the given Event property and long integer range. The lower and upper values of the range are specified as well as a boolean indicating that the comparison should be inclusive or exclusive of these values.

Parameters:

property - The event property to be evaluated in the expression.

lower - The lower bounds of the expression.

upper - The upper bounds of the expression.

inclusive - A boolean indicating the range is inclusive.

Returns:

A reference to this query builder instance to enable method chaining

between

public ExpressionBuilder between(java.lang.String property,
                                 java.lang.Float lower,
                                 java.lang.Float upper,
                                 boolean inclusive)

Add a between expression for the given Event property and floating point range. The lower and upper values of the range are specified as well as a boolean indicating that the comparison should be inclusive or exclusive of these values.

Parameters:

property - The event property to be evaluated in the expression.

lower - The lower bounds of the expression.

upper - The upper bounds of the expression.

inclusive - A boolean indicating the range is inclusive.

Returns:

A reference to this query builder instance to enable method chaining

between

public ExpressionBuilder between(java.lang.String property,
                                 java.lang.Double lower,
                                 java.lang.Double upper,
                                 boolean inclusive)

Add a between expression for the given Event property and double precision floating point range. The lower and upper values of the range are specified as well as a boolean indicating that the comparison should be inclusive or exclusive of these values.

Parameters:

property - The event property to be evaluated in the expression.

lower - The lower bounds of the expression.

upper - The upper bounds of the expression.

inclusive - A boolean indicating the range is inclusive.

Returns:

A reference to this query builder instance to enable method chaining

between

public ExpressionBuilder between(java.lang.String property,
                                 java.sql.Timestamp lower,
                                 java.sql.Timestamp upper,
                                 boolean inclusive)

Add a between expression for the given Event property and timestamp range. The lower and upper values of the range are specified as well as a boolean indicating that the comparison should be inclusive or exclusive of these values.

Parameters:

property - The event property to be evaluated in the expression.

lower - The lower bounds of the expression.

upper - The upper bounds of the expression.

inclusive - A boolean indicating the range is inclusive.

Returns:

A reference to this query builder instance to enable method chaining

between

public ExpressionBuilder between(ExpressionBuilder subexpression)

Create a between expression using the specified sub-expression. Sub-expressions are added to the query and treated as having explicit precedence. The sub-expression will be wrapped in left and right parenthesis. Explicit precedence for the expression can be controlled through the use of these sub-expressions.

Parameters:

subexpression - The builder used to create the sub-expression.

Returns:

A reference to this query builder instance to enable method chaining

or

public ExpressionBuilder or()

Adds an OR operator to the current query expression. The method should be used between calls to the "simple" and "between" methods. As mentioned earlier when you build the query expressions you are working from left to right. For example joining two simple expressions such as .simple(x).or().simple(y).

Returns:

A reference to this query builder instance to enable method chaining

or

public ExpressionBuilder or(ExpressionBuilder subexpression)

Adds an OR operator to the current query expression. However this method takes another instance of an ExpressionBuilder and is used to represent a sub-expression. An OR operator is added to the expression then the sub-expression is wrapped in a left and right parenthesis. This allows the developer to explicitly control the precedence at which the expression is evaluated.

Returns:

A reference to this query builder instance to enable method chaining

and

public ExpressionBuilder and()

Adds an AND operator to the current query expression. The method should be used between calls to the "simple" and "between" methods. As mentioned earlier when you build the query expressions you are working from left to right. For example joining two simple expressions such as .simple(x).and().simple(y).

Returns:

A reference to this query builder instance to enable method chaining

and

public ExpressionBuilder and(ExpressionBuilder subexpression)

Adds an AND operator to the current query expression. However this method takes another instance of an ExpressionBuilder and is used to represent a sub-expression. An OR operator is added to the expression then the sub-expression is wrapped in a left and right parenthesis. This allows the developer to explicitly control the precedence at which the expression is evaluated.

Returns:

A reference to this query builder instance to enable method chaining

getExpression

public java.lang.StringBuilder getExpression()