to.etc.webapp.query

Class QCriteria<T>

java.lang.Object

to.etc.webapp.query.QRestrictor<T>

to.etc.webapp.query.QCriteriaQueryBase<T>

to.etc.webapp.query.QCriteria<T>

public class QCriteria<T>
extends QCriteriaQueryBase<T>

Represents the selection of a list of persistent entity classes from the database. A QCriteria has a fixed type (the type of the class being selected) and maintains the list of conditions (criteria's) that the selection must hold. This is a concrete representation of something representing a query tree. To use a QCriteria in an actual query you need a translator which translates the QCriteria tree into something for the target persistence layer. Implementations of such a translator for Hibernate, SPF, simple SQL/JDBC and in-memory lists exist.

Author:

Frits Jalvingh Created on Jun 24, 2008

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QCriteria(Class<T> b)

Method Summary

Modifier and Type	Method and Description
QCriteria<T>	add(QOperatorNode r)
QCriteria<T>	add(QOrder r) Add an order clause to the list of sort items.
QCriteria<T>	ascending(String property) Add a property to do an ascending sort on.
QCriteria<T>	between(String property, Object a, Object b) Compare the value of a property with two literal bounds.
static <U> QCriteria<U>	create(Class<U> clz) Create a QCriteria to select a set of the specified class.
static <U> QCriteria<U>	create(ICriteriaTableDef<U> root) EXPERIMENTAL Create a QCriteria on some metadata structured data.
QCriteria<T>	descending(String property) Add a property to do a descending sort on.
<V,R extends QField<R,T>> QCriteria<T>	eq(QField<R,V> property, V value) Compare a property with some value.
<R extends QField<R,T>> QCriteria<T>	eq(QFieldDouble<R> property, double value)
QCriteria<T>	eq(String property, double value) Compare a property with some literal object value.
QCriteria<T>	eq(String property, long value) Compare a property with some literal object value.
QCriteria<T>	eq(String property, Object value) Compare a property with some literal object value.
QCriteria<T>	fetch(String property)
QCriteria<T>	fetch(String property, QFetchStrategy strategy) Set a fetch strategy for a relation.
QCriteria<T>	ge(String property, double value) Compare a property with some literal object value.
QCriteria<T>	ge(String property, long value) Compare a property with some literal object value.
QCriteria<T>	ge(String property, Object value) Compare a property with some literal object value.
QCriteria<T>	gt(String property, double value) Compare a property with some literal object value.
QCriteria<T>	gt(String property, long value) Compare a property with some literal object value.
QCriteria<T>	gt(String property, Object value) Compare a property with some literal object value.
QCriteria<T>	ilike(String property, Object value) Do a case-independent 'like' comparison.
<V,R extends QField<R,T>> QCriteria<T>	in(QField<R,V> property, List<V> value) A property must be one of a list of values.
<V> QCriteria<T>	in(String property, List<V> inlist) A property must be one of a list of values.
<V> QCriteria<T>	in(String property, QSelection<?> selection)
QCriteria<T>	isnotnull(String property) Add the restriction that the property specified must be not-null.
QCriteria<T>	isnull(String property) Add the restriction that the property specified must be null.
QCriteria<T>	le(String property, double value) Compare a property with some literal object value.
QCriteria<T>	le(String property, long value) Compare a property with some literal object value.
QCriteria<T>	le(String property, Object value) Compare a property with some literal object value.
QCriteria<T>	like(String property, Object value) Do a 'like' comparison.
QCriteria<T>	limit(int limit) Limit the #of rows to the specified count.
QCriteria<T>	lt(String property, double value) Compare a property with some literal object value.
QCriteria<T>	lt(String property, long value) Compare a property with some literal object value.
QCriteria<T>	lt(String property, Object value) Compare a property with some literal object value.
<V,R extends QField<R,T>> QCriteria<T>	ne(QField<R,V> property, V value) Compare a property with some value.
QCriteria<T>	ne(String property, double value) Compare a property with some literal object value.
QCriteria<T>	ne(String property, long value) Compare a property with some literal object value.
QCriteria<T>	ne(String property, Object value) Compare a property with some literal object value.
QCriteria<T>	or(QOperatorNode a1, QOperatorNode a2, QOperatorNode... a) Deprecated.
QCriteria<T>	sqlCondition(String sql) Add a restriction specified in bare SQL.
QCriteria<T>	sqlCondition(String sql, Object[] params) Add a restriction in bare SQL, with JDBC parameters inside the string (specified as '?').
QCriteria<T>	start(int start) Start returning rows at the specified index in the result set (0-based).
QCriteria<T>	testId(String testId) Used to easily identify criteria within tests.
String	toString()
void	visit(QNodeVisitor v) Visit everything in this QCriteria.

Methods inherited from class to.etc.webapp.query.QCriteriaQueryBase

addColumn, addPropertySelection, avg, avg, count, count, countDistinct, countDistinct, distinct, distinct, getColumnList, getFetchStrategies, getLimit, getOption, getOrder, getRestrictions, getStart, getTestId, getTimeout, hasOption, max, max, min, min, selectProperty, selectProperty, setOption, setRestrictions, setTestId, setTimeout, sum, sum

Methods inherited from class to.etc.webapp.query.QRestrictor

and, exists, exists, getBaseClass, getMetaTable, getReturnClass, getUnusedSubquerySet, hasRestrictions, internalAdd, internalUseQuery, mergeCriteria, not, or, subquery

Methods inherited from class java.lang.Object

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

Constructor Detail

QCriteria

protected QCriteria(@Nonnull
                    Class<T> b)

Method Detail

create

@Nonnull
public static <U> QCriteria<U> create(@Nonnull
                                               Class<U> clz)

Create a QCriteria to select a set of the specified class. When used on it's own without added criteria this selects all possible items.

Type Parameters:

U -

Parameters:

clz -

Returns:

create

@Nonnull
public static <U> QCriteria<U> create(@Nonnull
                                               ICriteriaTableDef<U> root)

EXPERIMENTAL Create a QCriteria on some metadata structured data.

Type Parameters:

U -

Parameters:

root -

Returns:

visit

public void visit(@Nonnull
                  QNodeVisitor v)
           throws Exception

Visit everything in this QCriteria.

Parameters:

v -

Throws:

Exception

add

@Nonnull
public QCriteria<T> add(@Nonnull
                                 QOperatorNode r)

Overrides:

add in class QRestrictor<T>

See Also:

QRestrictor.add(to.etc.webapp.query.QOperatorNode)

add

@Nonnull
public QCriteria<T> add(@Nonnull
                                 QOrder r)

Add an order clause to the list of sort items.

Overrides:

add in class QCriteriaQueryBase<T>

Returns:

See Also:

QCriteriaQueryBase.add(to.etc.webapp.query.QOrder)

ascending

@Nonnull
public QCriteria<T> ascending(@Nonnull
                                       String property)

Add a property to do an ascending sort on.

Overrides:

ascending in class QCriteriaQueryBase<T>

Returns:

See Also:

QCriteriaQueryBase.ascending(java.lang.String)

between

@Nonnull
public QCriteria<T> between(@Nonnull
                                     String property,
                                     @Nonnull
                                     Object a,
                                     @Nonnull
                                     Object b)

Compare the value of a property with two literal bounds.

Overrides:

between in class QRestrictor<T>

Returns:

See Also:

QRestrictor.between(java.lang.String, java.lang.Object, java.lang.Object)

descending

@Nonnull
public QCriteria<T> descending(@Nonnull
                                        String property)

Add a property to do a descending sort on.

Overrides:

descending in class QCriteriaQueryBase<T>

Returns:

See Also:

QCriteriaQueryBase.descending(java.lang.String)

eq

@Nonnull
public QCriteria<T> eq(@Nonnull
                                String property,
                                double value)

Compare a property with some literal object value.

Overrides:

eq in class QRestrictor<T>

Returns:

See Also:

QRestrictor.eq(java.lang.String, double)

eq

@Nonnull
public QCriteria<T> eq(@Nonnull
                                String property,
                                long value)

Compare a property with some literal object value.

Overrides:

eq in class QRestrictor<T>

Returns:

See Also:

QRestrictor.eq(java.lang.String, long)

eq

@Nonnull
public QCriteria<T> eq(@Nonnull
                                String property,
                                @Nullable
                                Object value)

Compare a property with some literal object value.

Overrides:

eq in class QRestrictor<T>

Returns:

See Also:

QRestrictor.eq(java.lang.String, java.lang.Object)

eq

@Nonnull
public <V,R extends QField<R,T>> QCriteria<T> eq(@Nonnull
                                                          QField<R,V> property,
                                                          @Nonnull
                                                          V value)

Compare a property with some value.

Overrides:

eq in class QRestrictor<T>

Returns:

See Also:

QRestrictor.eq(java.lang.String, java.lang.Object)

ne

@Nonnull
public <V,R extends QField<R,T>> QCriteria<T> ne(@Nonnull
                                                          QField<R,V> property,
                                                          @Nonnull
                                                          V value)

Compare a property with some value.

Overrides:

ne in class QRestrictor<T>

Returns:

See Also:

QRestrictor.eq(java.lang.String, java.lang.Object)

eq

@Nonnull
public <R extends QField<R,T>> QCriteria<T> eq(@Nonnull
                                                        QFieldDouble<R> property,
                                                        double value)

Overrides:

eq in class QRestrictor<T>

See Also:

QRestrictor.eq(java.lang.String, java.lang.Object)

ge

@Nonnull
public QCriteria<T> ge(@Nonnull
                                String property,
                                double value)

Compare a property with some literal object value.

Overrides:

ge in class QRestrictor<T>

Returns:

See Also:

QRestrictor.ge(java.lang.String, double)

ge

@Nonnull
public QCriteria<T> ge(@Nonnull
                                String property,
                                long value)

Compare a property with some literal object value.

Overrides:

ge in class QRestrictor<T>

Returns:

See Also:

QRestrictor.ge(java.lang.String, long)

ge

@Nonnull
public QCriteria<T> ge(@Nonnull
                                String property,
                                @Nonnull
                                Object value)

Compare a property with some literal object value.

Overrides:

ge in class QRestrictor<T>

Returns:

See Also:

QRestrictor.ge(java.lang.String, java.lang.Object)

gt

@Nonnull
public QCriteria<T> gt(@Nonnull
                                String property,
                                double value)

Compare a property with some literal object value.

Overrides:

gt in class QRestrictor<T>

Returns:

See Also:

QRestrictor.gt(java.lang.String, double)

gt

@Nonnull
public QCriteria<T> gt(@Nonnull
                                String property,
                                long value)

Compare a property with some literal object value.

Overrides:

gt in class QRestrictor<T>

Returns:

See Also:

QRestrictor.gt(java.lang.String, long)

gt

@Nonnull
public QCriteria<T> gt(@Nonnull
                                String property,
                                @Nonnull
                                Object value)

Compare a property with some literal object value.

Overrides:

gt in class QRestrictor<T>

Returns:

See Also:

QRestrictor.gt(java.lang.String, java.lang.Object)

ilike

@Nonnull
public QCriteria<T> ilike(@Nonnull
                                   String property,
                                   @Nonnull
                                   Object value)

Do a case-independent 'like' comparison. The wildcard marks here are always %; a literal % is to be presented as \%. The comparison is case-independent.

Overrides:

ilike in class QRestrictor<T>

Returns:

See Also:

QRestrictor.ilike(java.lang.String, java.lang.Object)

isnotnull

@Nonnull
public QCriteria<T> isnotnull(@Nonnull
                                       String property)

Add the restriction that the property specified must be not-null.

Overrides:

isnotnull in class QRestrictor<T>

Returns:

See Also:

QRestrictor.isnotnull(java.lang.String)

isnull

@Nonnull
public QCriteria<T> isnull(@Nonnull
                                    String property)

Add the restriction that the property specified must be null.

Overrides:

isnull in class QRestrictor<T>

Returns:

See Also:

QRestrictor.isnull(java.lang.String)

le

@Nonnull
public QCriteria<T> le(@Nonnull
                                String property,
                                double value)

Compare a property with some literal object value.

Overrides:

le in class QRestrictor<T>

Returns:

See Also:

QRestrictor.le(java.lang.String, double)

le

@Nonnull
public QCriteria<T> le(@Nonnull
                                String property,
                                long value)

Compare a property with some literal object value.

Overrides:

le in class QRestrictor<T>

Returns:

See Also:

QRestrictor.le(java.lang.String, long)

le

@Nonnull
public QCriteria<T> le(@Nonnull
                                String property,
                                @Nonnull
                                Object value)

Compare a property with some literal object value.

Overrides:

le in class QRestrictor<T>

Returns:

See Also:

QRestrictor.le(java.lang.String, java.lang.Object)

like

@Nonnull
public QCriteria<T> like(@Nonnull
                                  String property,
                                  @Nonnull
                                  Object value)

Do a 'like' comparison. The wildcard marks here are always %; a literal % is to be presented as \%. The comparison is case-dependent.

Overrides:

like in class QRestrictor<T>

Returns:

See Also:

QRestrictor.like(java.lang.String, java.lang.Object)

lt

@Nonnull
public QCriteria<T> lt(@Nonnull
                                String property,
                                double value)

Compare a property with some literal object value.

Overrides:

lt in class QRestrictor<T>

Returns:

See Also:

QRestrictor.lt(java.lang.String, double)

lt

@Nonnull
public QCriteria<T> lt(@Nonnull
                                String property,
                                long value)

Compare a property with some literal object value.

Overrides:

lt in class QRestrictor<T>

Returns:

See Also:

QRestrictor.lt(java.lang.String, long)

lt

@Nonnull
public QCriteria<T> lt(@Nonnull
                                String property,
                                @Nonnull
                                Object value)

Compare a property with some literal object value.

Overrides:

lt in class QRestrictor<T>

Returns:

See Also:

QRestrictor.lt(java.lang.String, java.lang.Object)

ne

@Nonnull
public QCriteria<T> ne(@Nonnull
                                String property,
                                double value)

Compare a property with some literal object value.

Overrides:

ne in class QRestrictor<T>

Returns:

See Also:

QRestrictor.ne(java.lang.String, double)

ne

@Nonnull
public QCriteria<T> ne(@Nonnull
                                String property,
                                long value)

Compare a property with some literal object value.

Overrides:

ne in class QRestrictor<T>

Returns:

See Also:

QRestrictor.ne(java.lang.String, long)

ne

@Nonnull
public QCriteria<T> ne(@Nonnull
                                String property,
                                @Nullable
                                Object value)

Compare a property with some literal object value.

Overrides:

ne in class QRestrictor<T>

Returns:

See Also:

QRestrictor.ne(java.lang.String, java.lang.Object)

or

@Deprecated
 @Nonnull
public QCriteria<T> or(@Nonnull
                                             QOperatorNode a1,
                                             @Nonnull
                                             QOperatorNode a2,
                                             @Nonnull
                                             QOperatorNode... a)

Deprecated.

Add a set of OR nodes to the set.

Overrides:

or in class QRestrictor<T>

Returns:

See Also:

to.etc.webapp.query.QCriteriaQueryBase#or(to.etc.webapp.query.QOperatorNode[])

sqlCondition

@Nonnull
public QCriteria<T> sqlCondition(@Nonnull
                                          String sql)

Add a restriction specified in bare SQL. This is implementation-dependent.

Overrides:

sqlCondition in class QRestrictor<T>

Returns:

See Also:

QRestrictor.sqlCondition(java.lang.String)

sqlCondition

@Nonnull
public QCriteria<T> sqlCondition(@Nonnull
                                          String sql,
                                          @Nonnull
                                          Object[] params)

Add a restriction in bare SQL, with JDBC parameters inside the string (specified as '?'). This is implementation-dependent. The first ? in the string corresponds to params[0]. Parameters are not allowed to be null (i.e. the type is @Nonnull Object[@Nonnull] or something). Alternatively parameters can be given as ":nnn" where nnn is the 1-based index in the params array.

Overrides:

sqlCondition in class QRestrictor<T>

Returns:

See Also:

QRestrictor.sqlCondition(java.lang.String)

limit

@Nonnull
public QCriteria<T> limit(int limit)

Limit the #of rows to the specified count.

Overrides:

limit in class QCriteriaQueryBase<T>

Returns:

See Also:

QCriteriaQueryBase.limit(int)

start

@Nonnull
public QCriteria<T> start(int start)

Start returning rows at the specified index in the result set (0-based).

Overrides:

start in class QCriteriaQueryBase<T>

Returns:

See Also:

QCriteriaQueryBase.start(int)

fetch

@Nonnull
public QCriteria<T> fetch(@Nonnull
                                   String property,
                                   @Nonnull
                                   QFetchStrategy strategy)

Description copied from class: QCriteriaQueryBase

Set a fetch strategy for a relation.

Overrides:

fetch in class QCriteriaQueryBase<T>

Returns:

fetch

@Nonnull
public QCriteria<T> fetch(@Nonnull
                                   String property)

in

@Nonnull
public <V> QCriteria<T> in(@Nonnull
                                    String property,
                                    List<V> inlist)

Description copied from class: QRestrictor

A property must be one of a list of values.

Overrides:

in in class QRestrictor<T>

Returns:

in

@Nonnull
public <V> QCriteria<T> in(@Nonnull
                                    String property,
                                    QSelection<?> selection)

Overrides:

in in class QRestrictor<T>

in

@Nonnull
public <V,R extends QField<R,T>> QCriteria<T> in(@Nonnull
                                                          QField<R,V> property,
                                                          @Nonnull
                                                          List<V> value)

Description copied from class: QRestrictor

A property must be one of a list of values.

Overrides:

in in class QRestrictor<T>

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

testId

public QCriteria<T> testId(@Nonnull
                           String testId)

Used to easily identify criteria within tests.

Parameters:

testId -

Returns: