QSelection (domui :: webapp-core 1.1 API)

java.lang.Object
- to.etc.webapp.query.QRestrictor<T>
- - to.etc.webapp.query.QCriteriaQueryBase<T>
  - - to.etc.webapp.query.QSelection<T>

Direct Known Subclasses:

QSubQuery
```
public class QSelection<T>
extends QCriteriaQueryBase<T>
```
Represents a selection of data elements from a database. This differs from a QCriteria in that it collects not one persistent class instance per row but multiple items per row, and each item can either be a persistent class or some property or calculated value (max, min, count et al).
Even though this type has a generic type parameter representing the base object being queried, the list() method for this object will return a List always.

QSelection queries return an array of items for each row, and each element of the array is typed depending on it's source. In addition, QSelection queries expose the ability to handle grouping. QSelection criteria behave as and should be seen as SQL queries in an OO wrapping.

Author:

Frits Jalvingh Created on Jul 14, 2009

Constructor Summary

Constructors
Modifier Constructor and Description

protected QSelection(Class<T> clz)

Constructors
Modifier	Constructor and Description
`protected`	`QSelection(Class<T> clz)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`QSelection<T>`	`add(QOperatorNode r)`
`QSelection<T>`	`add(QOrder r)` Add an order clause to the list of sort items.
`void`	`addColumn(QSelectionItem item, String alias)` Add a column selector to the selection list.
`void`	`addPropertySelection(QSelectionFunction f, String prop, String alias)` Add a simple property selector to the list.
`QSelection<T>`	`ascending(String property)` Add a property to do an ascending sort on.
`QSelection<T>`	`avg(String property)` Select the average value of a property in the set.
`QSelection<T>`	`avg(String property, String alias)` Select the average value of a property in the set.
`QSelection<T>`	`between(String property, Object a, Object b)` Compare the value of a property with two literal bounds.
`QSelection<T>`	`count(String property)` Select a count over the result set.
`QSelection<T>`	`count(String property, String alias)` Select a count over the result set.
`QSelection<T>`	`countDistinct(String property)` Select a count of the distinct values over the result set.
`QSelection<T>`	`countDistinct(String property, String alias)` Select a count of the distinct values over the result set.
`static <T> QSelection<T>`	`create(Class<T> root)` Create a selection query based on the specified persistent class (public API).
`QSelection<T>`	`descending(String property)` Add a property to do a descending sort on.
`QSelection<T>`	`distinct(String property)` Select of the distinct values over the result set.
`QSelection<T>`	`distinct(String property, String alias)` Select of the distinct values over the result set.
`QSelection<T>`	`eq(String property, double value)` Compare a property with some literal object value.
`QSelection<T>`	`eq(String property, long value)` Compare a property with some literal object value.
`QSelection<T>`	`eq(String property, Object value)` Compare a property with some literal object value.
`QSelection<T>`	`fetch(String property)`
`QSelection<T>`	`fetch(String property, QFetchStrategy strategy)` Set a fetch strategy for a relation.
`QSelection<T>`	`ge(String property, double value)` Compare a property with some literal object value.
`QSelection<T>`	`ge(String property, long value)` Compare a property with some literal object value.
`QSelection<T>`	`ge(String property, Object value)` Compare a property with some literal object value.
`QSelection<T>`	`gt(String property, double value)` Compare a property with some literal object value.
`QSelection<T>`	`gt(String property, long value)` Compare a property with some literal object value.
`QSelection<T>`	`gt(String property, Object value)` Compare a property with some literal object value.
`QSelection<T>`	`ilike(String property, Object value)` Do a case-independent 'like' comparison.
`QSelection<T>`	`isnotnull(String property)` Add the restriction that the property specified must be not-null.
`QSelection<T>`	`isnull(String property)` Add the restriction that the property specified must be null.
`QSelection<T>`	`le(String property, double value)` Compare a property with some literal object value.
`QSelection<T>`	`le(String property, long value)` Compare a property with some literal object value.
`QSelection<T>`	`le(String property, Object value)` Compare a property with some literal object value.
`QSelection<T>`	`like(String property, Object value)` Do a 'like' comparison.
`QSelection<T>`	`lt(String property, double value)` Compare a property with some literal object value.
`QSelection<T>`	`lt(String property, long value)` Compare a property with some literal object value.
`QSelection<T>`	`lt(String property, Object value)` Compare a property with some literal object value.
`QSelection<T>`	`max(String property)` Select the max of a property in the set.
`QSelection<T>`	`max(String property, String alias)` Select the max of a property in the set.
`QSelection<T>`	`min(String property)` Select the minimal value of a property in the set.
`QSelection<T>`	`min(String property, String alias)` Select the minimal value of a property in the set.
`QSelection<T>`	`ne(String property, double value)` Compare a property with some literal object value.
`QSelection<T>`	`ne(String property, long value)` Compare a property with some literal object value.
`QSelection<T>`	`ne(String property, Object value)` Compare a property with some literal object value.
`QSelection<T>`	`or(QOperatorNode a1, QOperatorNode a2, QOperatorNode... a)` Deprecated.
`QSelection<T>`	`selectProperty(String property)` Select a property value from the base property in the result set.
`QSelection<T>`	`selectProperty(String property, String alias)` Select a property value from the base property in the result set.
`QSelection<T>`	`sqlCondition(String sql)` Add a restriction specified in bare SQL.
`QSelection<T>`	`sum(String property)` Select the sum of a property in the set.
`QSelection<T>`	`sum(String property, String alias)` Select the sum of a property in the set.
`QSelection<T>`	`testId(String testId)`
`String`	`toString()`
`void`	`visit(QNodeVisitor v)`

Methods inherited from class to.etc.webapp.query.QCriteriaQueryBase
getColumnList, getFetchStrategies, getLimit, getOption, getOrder, getRestrictions, getStart, getTestId, getTimeout, hasOption, limit, setOption, setRestrictions, setTestId, setTimeout, start

Methods inherited from class to.etc.webapp.query.QRestrictor
and, eq, eq, exists, exists, getBaseClass, getMetaTable, getReturnClass, getUnusedSubquerySet, hasRestrictions, in, in, in, internalAdd, internalUseQuery, mergeCriteria, ne, not, or, sqlCondition, subquery

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QSelection

protected QSelection(@Nonnull
                     Class<T> clz)

Method Detail

create
```
public static <T> QSelection<T> create(Class<T> root)
```
Create a selection query based on the specified persistent class (public API).

Type Parameters:

T - The base type being queried

Parameters:

root - The class representing the base type being queried, thanks to the brilliant Java Generics implementation.

Returns:

visit

public void visit(QNodeVisitor v)
           throws Exception

Throws:: Exception

addColumn

public void addColumn(@Nonnull
                      QSelectionItem item,
                      @Nullable
                      String alias)

Add a column selector to the selection list.

Overrides:: addColumn in class QCriteriaQueryBase<T>

addPropertySelection

public void addPropertySelection(@Nonnull
                                 QSelectionFunction f,
                                 @Nonnull
                                 String prop,
                                 @Nullable
                                 String alias)

Add a simple property selector to the list.

Overrides:: addPropertySelection in class QCriteriaQueryBase<T>

avg

@Nonnull
public QSelection<T> avg(@Nonnull
                                  String property,
                                  @Nullable
                                  String alias)

Select the average value of a property in the set. This will cause a group by.

Overrides:: avg in class QCriteriaQueryBase<T>
Parameters:: property - The property whose literal value is to be selected; alias - The alias for using the property in the restrictions clause.
Returns:

avg
```
@Nonnull
public QSelection<T> avg(@Nonnull
                                  String property)
```
Select the average value of a property in the set. This will cause a group by.

Overrides:

avg in class QCriteriaQueryBase<T>

Parameters:

property - The property whose literal value is to be selected

Returns:

count

@Nonnull
public QSelection<T> count(@Nonnull
                                    String property,
                                    @Nullable
                                    String alias)

Select a count over the result set.

Overrides:: count in class QCriteriaQueryBase<T>
Parameters:: property - The property whose literal value is to be selected; alias - The alias for using the property in the restrictions clause.
Returns:

count
```
@Nonnull
public QSelection<T> count(@Nonnull
                                    String property)
```
Select a count over the result set.

Overrides:

count in class QCriteriaQueryBase<T>

Parameters:

property - The property whose literal value is to be selected

Returns:

countDistinct

@Nonnull
public QSelection<T> countDistinct(@Nonnull
                                            String property,
                                            @Nullable
                                            String alias)

Select a count of the distinct values over the result set.

Overrides:: countDistinct in class QCriteriaQueryBase<T>
Parameters:: property - The property whose literal value is to be selected; alias - The alias for using the property in the restrictions clause.
Returns:

countDistinct
```
@Nonnull
public QSelection<T> countDistinct(@Nonnull
                                            String property)
```
Select a count of the distinct values over the result set.

Overrides:

countDistinct in class QCriteriaQueryBase<T>

Parameters:

property - The property whose literal value is to be selected

Returns:

distinct

@Nonnull
public QSelection<T> distinct(@Nonnull
                                       String property,
                                       @Nullable
                                       String alias)

Select of the distinct values over the result set.

Overrides:: distinct in class QCriteriaQueryBase<T>
Parameters:: property - The property whose literal value is to be selected
Returns:

distinct
```
@Nonnull
public QSelection<T> distinct(@Nonnull
                                       String property)
```
Select of the distinct values over the result set.

Overrides:

distinct in class QCriteriaQueryBase<T>

Parameters:

property - The property whose literal value is to be selected

Returns:

max

@Nonnull
public QSelection<T> max(@Nonnull
                                  String property,
                                  @Nullable
                                  String alias)

Select the max of a property in the set. This will cause a group by.

Overrides:: max in class QCriteriaQueryBase<T>
Parameters:: property - The property whose literal value is to be selected; alias - The alias for using the property in the restrictions clause.
Returns:

max
```
@Nonnull
public QSelection<T> max(@Nonnull
                                  String property)
```
Select the max of a property in the set. This will cause a group by.

Overrides:

max in class QCriteriaQueryBase<T>

Parameters:

property - The property whose literal value is to be selected

Returns:

min

@Nonnull
public QSelection<T> min(@Nonnull
                                  String property,
                                  @Nullable
                                  String alias)

Select the minimal value of a property in the set. This will cause a group by.

Overrides:: min in class QCriteriaQueryBase<T>
Parameters:: property - The property whose literal value is to be selected; alias - The alias for using the property in the restrictions clause.
Returns:

min
```
@Nonnull
public QSelection<T> min(@Nonnull
                                  String property)
```
Select the minimal value of a property in the set. This will cause a group by.

Overrides:

min in class QCriteriaQueryBase<T>

Parameters:

property - The property whose literal value is to be selected

Returns:

selectProperty

@Nonnull
public QSelection<T> selectProperty(@Nonnull
                                             String property,
                                             @Nullable
                                             String alias)

Select a property value from the base property in the result set.

Overrides:: selectProperty in class QCriteriaQueryBase<T>
Parameters:: property - The property whose literal value is to be selected; alias - The alias for using the property in the restrictions clause.
Returns:

selectProperty
```
@Nonnull
public QSelection<T> selectProperty(@Nonnull
                                             String property)
```
Select a property value from the base property in the result set.

Overrides:

selectProperty in class QCriteriaQueryBase<T>

Parameters:

property - The property whose literal value is to be selected

Returns:

sum

@Nonnull
public QSelection<T> sum(@Nonnull
                                  String property,
                                  @Nullable
                                  String alias)

Select the sum of a property in the set. This will cause a group by.

Overrides:: sum in class QCriteriaQueryBase<T>
Parameters:: property - The property whose literal value is to be selected; alias - The alias for using the property in the restrictions clause.
Returns:

sum
```
@Nonnull
public QSelection<T> sum(@Nonnull
                                  String property)
```
Select the sum of a property in the set. This will cause a group by.

Overrides:

sum in class QCriteriaQueryBase<T>

Parameters:

property - The property whose literal value is to be selected

Returns:

add

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

Overrides:: add in class QRestrictor<T>
See Also:: QRestrictor.add(to.etc.webapp.query.QOperatorNode)

add
```
@Nonnull
public QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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)

ge

@Nonnull
public QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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 QSelection<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)

fetch

@Nonnull
public QSelection<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 QSelection<T> fetch(@Nonnull
                                    String property)

toString
```
@Nonnull
public String toString()
```
Overrides:

toString in class Object

testId

public QSelection<T> testId(@Nullable
                            String testId)

Class QSelection<T>

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

QSelection

Method Detail

create

visit

addColumn

addPropertySelection

avg

avg

count

count

countDistinct

countDistinct

distinct

distinct

max

max

min

min

selectProperty

selectProperty

sum

sum

add

add

ascending

between

descending

eq

eq

eq

ge

ge

ge

gt

gt

gt

ilike

isnotnull

isnull

le

le

le

like

lt

lt

lt

ne

ne

ne

or

sqlCondition

fetch

fetch

toString

testId