com.edorasware.commons.core.query

Class BasicOperand<T>

java.lang.Object

com.edorasware.commons.core.query.BasicOperand<T>

Type Parameters:

T - the type of this predicate operand

Direct Known Subclasses:

BooleanOperand, DateOperand, NumberOperand, StringOperand, WorkObjectStateOperand

public class BasicOperand<T>
extends Object

Wraps a QueryParameter (i.e. left operand) and allows to build Predicates.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicOperand.InnerSelectReferenceValue Inner select reference value used by the eq(Predicate) method to render the inner select statement with the given parameter as the column name and the given predicate as the right operand.

Field Summary

Fields

Modifier and Type	Field and Description
protected ConstructionInterceptor	constructionInterceptor The interceptor invoked upon construction of predicates or orderings.
protected QueryParameter	queryParameter The query parameter (i.e. left operand).

Constructor Summary

Constructors

Constructor and Description
BasicOperand(QueryParameter queryParameter) Creates a new operand instance.
BasicOperand(QueryParameter queryParameter, ConstructionInterceptor constructionInterceptor) Creates a new operand instance.

Method Summary

Modifier and Type	Method and Description
Predicate	eq(BasicOperand<?> operand, Predicate innerSelectPredicate) Builds a predicate which tests the queryParameter of the given operand is equal to a single match of the given inner select predicate.
Predicate	eq(Predicate innerSelectPredicate) Builds a predicate which tests the queryParameter of this operand is equal to a single match of the given inner select predicate.
Predicate	eq(T expectedValue) Builds a predicate representing a queryParameter = expectedValue comparison.
Predicate	in(BasicOperand<?> operand, Predicate innerSelectPredicate) Builds a predicate which tests the queryParameter of the given operand to be contained in any of the given inner select predicate matches.
Predicate	in(Collection<? extends T> possibleValues) Builds a predicate which tests that the queryParameter of this operand contains any of the given possibleValues.
Predicate	in(Predicate innerSelectPredicate) Builds a predicate which tests the queryParameter of this operand to be contained in any of the given inner select predicate matches.
Predicate	in(T possibleValue) Builds a predicate which tests that the queryParameter of this operand contains possibleValue1.
Predicate	in(T possibleValue1, T possibleValue2) Builds a predicate which tests that the queryParameter of this operand contains either possibleValue1 or possibleValue2.
Predicate	in(T possibleValue1, T possibleValue2, T possibleValue3) Builds a predicate which tests that the queryParameter of this operand contains either possibleValue1, possibleValue2, or possibleValue3.
Predicate	in(T possibleValue1, T possibleValue2, T possibleValue3, T... morePossibleValues) Builds a predicate which tests that the queryParameter of this operand contains either possibleValue1, possibleValue2, possibleValue3, or any of morePossibleValues.
protected Predicate	interceptPredicate(Predicate predicate)
protected Object	interceptValue(Object value)
Predicate	isNotNull() Builds a predicate representing a queryParameter IS NOT NULL comparison.
Predicate	isNull() Builds a predicate representing a queryParameter IS NULL comparison.
Ordering	orderAsc() Builds an ordering criterion which sorts the encapsulated parameter in ascending order.
Ordering	orderDesc() Builds an ordering criterion which sorts the encapsulated parameter in descending order.

Methods inherited from class java.lang.Object

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

Field Detail

queryParameter

protected final QueryParameter queryParameter

The query parameter (i.e. left operand).

constructionInterceptor

protected final ConstructionInterceptor constructionInterceptor

The interceptor invoked upon construction of predicates or orderings.

Constructor Detail

BasicOperand

public BasicOperand(QueryParameter queryParameter)

Creates a new operand instance.

Parameters:

queryParameter - the left operand for all predicates to be built

BasicOperand

public BasicOperand(QueryParameter queryParameter,
                    ConstructionInterceptor constructionInterceptor)

Creates a new operand instance.

Parameters:

queryParameter - the left operand for all predicates to be built

constructionInterceptor - the interceptor to be invoked upon construction of predicates

Method Detail

eq

public final Predicate eq(T expectedValue)

Builds a predicate representing a queryParameter = expectedValue comparison.

Parameters:

expectedValue - the expected value of the comparison

Returns:

the new predicate instance

eq

public final Predicate eq(Predicate innerSelectPredicate)

Builds a predicate which tests the queryParameter of this operand is equal to a single match of the given inner select predicate.

Parameters:

innerSelectPredicate - the inner select predicate

Returns:

the new predicate instance

eq

public final Predicate eq(BasicOperand<?> operand,
                          Predicate innerSelectPredicate)

Builds a predicate which tests the queryParameter of the given operand is equal to a single match of the given inner select predicate.

Parameters:

operand - the operand

innerSelectPredicate - the inner select predicate

Returns:

the new predicate instance

isNull

public final Predicate isNull()

Builds a predicate representing a queryParameter IS NULL comparison.

Returns:

the new predicate instance

isNotNull

public final Predicate isNotNull()

Builds a predicate representing a queryParameter IS NOT NULL comparison.

Returns:

the new predicate instance

in

public final Predicate in(T possibleValue)

Builds a predicate which tests that the queryParameter of this operand contains possibleValue1.

Parameters:

possibleValue - the expected value

Returns:

the new predicate instance

in

public final Predicate in(T possibleValue1,
                          T possibleValue2)

Builds a predicate which tests that the queryParameter of this operand contains either possibleValue1 or possibleValue2.

Parameters:

possibleValue1 - the first possible value

possibleValue2 - the second possible value

Returns:

the new predicate instance

in

public final Predicate in(T possibleValue1,
                          T possibleValue2,
                          T possibleValue3)

Builds a predicate which tests that the queryParameter of this operand contains either possibleValue1, possibleValue2, or possibleValue3.

Parameters:

possibleValue1 - the first possible value

possibleValue2 - the second possible value

possibleValue3 - the third possible value

Returns:

the new predicate instance

in

public final Predicate in(T possibleValue1,
                          T possibleValue2,
                          T possibleValue3,
                          T... morePossibleValues)

Builds a predicate which tests that the queryParameter of this operand contains either possibleValue1, possibleValue2, possibleValue3, or any of morePossibleValues.

Parameters:

possibleValue1 - the first possible value

possibleValue2 - the second possible value

possibleValue3 - the third possible value

morePossibleValues - more possible values

Returns:

the new predicate instance

in

public final Predicate in(Collection<? extends T> possibleValues)

Builds a predicate which tests that the queryParameter of this operand contains any of the given possibleValues.

Parameters:

possibleValues - the expected values (tested with OR semantics)

Returns:

the new predicate instance

in

public final Predicate in(Predicate innerSelectPredicate)

Builds a predicate which tests the queryParameter of this operand to be contained in any of the given inner select predicate matches.

Parameters:

innerSelectPredicate - the inner select predicate

Returns:

the new predicate instance

in

public final Predicate in(BasicOperand<?> operand,
                          Predicate innerSelectPredicate)

Builds a predicate which tests the queryParameter of the given operand to be contained in any of the given inner select predicate matches.

Parameters:

operand - the operand

innerSelectPredicate - the inner select predicate

Returns:

the new predicate instance

orderAsc

public final Ordering orderAsc()

Builds an ordering criterion which sorts the encapsulated parameter in ascending order.

Returns:

the new ordering instance

orderDesc

public final Ordering orderDesc()

Builds an ordering criterion which sorts the encapsulated parameter in descending order.

Returns:

the new ordering instance

interceptPredicate

protected final Predicate interceptPredicate(Predicate predicate)

interceptValue

protected final Object interceptValue(Object value)