to.etc.webapp.query

Class QCriteriaQueryBase<T>

java.lang.Object

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

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

Direct Known Subclasses:

QCriteria, QSelection

public class QCriteriaQueryBase<T>
extends QRestrictor<T>

Base class representing most of the query structure, just not the public interface part.

Author:

Frits Jalvingh Created on Jun 21, 2009

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QCriteriaQueryBase(Class<T> clz)
protected	QCriteriaQueryBase(ICriteriaTableDef<T> meta)

Method Summary

Modifier and Type	Method and Description
QCriteriaQueryBase<T>	add(QOrder r) Add an order clause to the list of sort items.
protected void	addColumn(QSelectionItem item, String alias) Add a column selector to the selection list.
protected void	addPropertySelection(QSelectionFunction f, String prop, String alias) Add a simple property selector to the list.
QCriteriaQueryBase<T>	ascending(String property) Add a property to do an ascending sort on.
protected QCriteriaQueryBase<T>	avg(String property) Select the average value of a property in the set.
protected QCriteriaQueryBase<T>	avg(String property, String alias) Select the average value of a property in the set.
protected QCriteriaQueryBase<T>	count(String property) Select a count over the result set.
protected QCriteriaQueryBase<T>	count(String property, String alias) Select a count over the result set.
protected QCriteriaQueryBase<T>	countDistinct(String property) Select a count of the distinct values over the result set.
protected QCriteriaQueryBase<T>	countDistinct(String property, String alias) Select a count of the distinct values over the result set.
QCriteriaQueryBase<T>	descending(String property) Add a property to do a descending sort on.
protected QCriteriaQueryBase<T>	distinct(String property) Select of the distinct values over the result set.
protected QCriteriaQueryBase<T>	distinct(String property, String alias) Select of the distinct values over the result set.
QCriteriaQueryBase<T>	fetch(String property, QFetchStrategy strategy) Set a fetch strategy for a relation.
List<QSelectionColumn>	getColumnList() Returns all selected columns.
Map<String,QFetchStrategy>	getFetchStrategies()
int	getLimit() Returns the limit.
Object	getOption(String name) Get the value stored for a given option.
List<QOrder>	getOrder() Returns the order-by list.
QOperatorNode	getRestrictions()
int	getStart() Returns the start index set.
String	getTestId()
int	getTimeout()
boolean	hasOption(String name) Returns T if the specified option is present.
QCriteriaQueryBase<T>	limit(int limit) Limit the #of rows to the specified count.
protected QCriteriaQueryBase<T>	max(String property) Select the max of a property in the set.
protected QCriteriaQueryBase<T>	max(String property, String alias) Select the max of a property in the set.
protected QCriteriaQueryBase<T>	min(String property) Select the minimal value of a property in the set.
protected QCriteriaQueryBase<T>	min(String property, String alias) Select the minimal value of a property in the set.
protected QCriteriaQueryBase<T>	selectProperty(String property) Select a property value from the base property in the result set.
protected QCriteriaQueryBase<T>	selectProperty(String property, String alias) Select a property value from the base property in the result set.
void	setOption(String name, Object val) Set an option for the query or some of it's listeners.
void	setRestrictions(QOperatorNode restrictions)
void	setTestId(String testId)
void	setTimeout(int timeout) Set the query timeout, in seconds.
QCriteriaQueryBase<T>	start(int start) Start returning rows at the specified index in the result set (0-based).
protected QCriteriaQueryBase<T>	sum(String property) Select the sum of a property in the set.
protected QCriteriaQueryBase<T>	sum(String property, String alias) Select the sum of a property in the set.

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

add, and, between, eq, eq, eq, eq, eq, exists, exists, ge, ge, ge, getBaseClass, getMetaTable, getReturnClass, getUnusedSubquerySet, gt, gt, gt, hasRestrictions, ilike, in, in, in, internalAdd, internalUseQuery, isnotnull, isnull, le, le, le, like, lt, lt, lt, mergeCriteria, ne, ne, ne, ne, not, or, or, sqlCondition, sqlCondition, subquery

Methods inherited from class java.lang.Object

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

Constructor Detail

QCriteriaQueryBase

protected QCriteriaQueryBase(@Nonnull
                             Class<T> clz)

QCriteriaQueryBase

protected QCriteriaQueryBase(@Nonnull
                             ICriteriaTableDef<T> meta)

Method Detail

getRestrictions

@Nullable
public QOperatorNode getRestrictions()

Specified by:

getRestrictions in class QRestrictor<T>

setRestrictions

public void setRestrictions(@Nullable
                            QOperatorNode restrictions)

Specified by:

setRestrictions in class QRestrictor<T>

getColumnList

@Nonnull
public List<QSelectionColumn> getColumnList()

Returns all selected columns.

Returns:

setOption

public void setOption(@Nonnull
                      String name,
                      @Nullable
                      Object val)

Set an option for the query or some of it's listeners.

Parameters:

name -

val -

hasOption

public boolean hasOption(@Nonnull
                         String name)

Returns T if the specified option is present.

Parameters:

name -

Returns:

getOption

@Nullable
public Object getOption(@Nonnull
                                  String name)

Get the value stored for a given option.

Parameters:

name -

Returns:

getFetchStrategies

@Nonnull
public Map<String,QFetchStrategy> getFetchStrategies()

addColumn

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

Add a column selector to the selection list.

addPropertySelection

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

Add a simple property selector to the list.

Parameters:

f -

prop -

alias -

selectProperty

@Nonnull
protected QCriteriaQueryBase<T> selectProperty(@Nonnull
                                                        String property)

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

Parameters:

property - The property whose literal value is to be selected

Returns:

selectProperty

@Nonnull
protected QCriteriaQueryBase<T> selectProperty(@Nonnull
                                                        String property,
                                                        @Nullable
                                                        String alias)

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

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
protected QCriteriaQueryBase<T> max(@Nonnull
                                             String property)

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

Parameters:

property - The property whose literal value is to be selected

Returns:

max

@Nonnull
protected QCriteriaQueryBase<T> max(@Nonnull
                                             String property,
                                             @Nullable
                                             String alias)

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

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
protected QCriteriaQueryBase<T> min(@Nonnull
                                             String property)

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

Parameters:

property - The property whose literal value is to be selected

Returns:

min

@Nonnull
protected QCriteriaQueryBase<T> min(@Nonnull
                                             String property,
                                             @Nullable
                                             String alias)

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

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
protected QCriteriaQueryBase<T> avg(@Nonnull
                                             String property)

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

Parameters:

property - The property whose literal value is to be selected

Returns:

avg

@Nonnull
protected QCriteriaQueryBase<T> avg(@Nonnull
                                             String property,
                                             @Nullable
                                             String alias)

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

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
protected QCriteriaQueryBase<T> sum(@Nonnull
                                             String property)

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

Parameters:

property - The property whose literal value is to be selected

Returns:

sum

@Nonnull
protected QCriteriaQueryBase<T> sum(@Nonnull
                                             String property,
                                             @Nullable
                                             String alias)

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

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
protected QCriteriaQueryBase<T> count(@Nonnull
                                               String property)

Select a count over the result set.

Parameters:

property - The property whose literal value is to be selected

Returns:

count

@Nonnull
protected QCriteriaQueryBase<T> count(@Nonnull
                                               String property,
                                               @Nullable
                                               String alias)

Select a count over the result set.

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
protected QCriteriaQueryBase<T> countDistinct(@Nonnull
                                                       String property)

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

Parameters:

property - The property whose literal value is to be selected

Returns:

countDistinct

@Nonnull
protected QCriteriaQueryBase<T> countDistinct(@Nonnull
                                                       String property,
                                                       @Nullable
                                                       String alias)

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

Parameters:

property - The property whose literal value is to be selected

alias - The alias for using the property in the restrictions clause.

Returns:

distinct

@Nonnull
protected QCriteriaQueryBase<T> distinct(@Nonnull
                                                  String property)

Select of the distinct values over the result set.

Parameters:

property - The property whose literal value is to be selected

Returns:

distinct

@Nonnull
protected QCriteriaQueryBase<T> distinct(@Nonnull
                                                  String property,
                                                  @Nullable
                                                  String alias)

Select of the distinct values over the result set.

Parameters:

property - The property whose literal value is to be selected

Returns:

add

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

Add an order clause to the list of sort items.

Parameters:

r -

Returns:

ascending

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

Add a property to do an ascending sort on.

Parameters:

property -

Returns:

descending

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

Add a property to do a descending sort on.

Parameters:

property -

Returns:

limit

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

Limit the #of rows to the specified count.

Parameters:

limit -

Returns:

start

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

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

Parameters:

start -

Returns:

getLimit

public final int getLimit()

Returns the limit.

Returns:

getStart

public final int getStart()

Returns the start index set.

Returns:

getOrder

@Nonnull
public final List<QOrder> getOrder()

Returns the order-by list.

Returns:

getTimeout

public int getTimeout()

setTimeout

public void setTimeout(int timeout)

Set the query timeout, in seconds. This only works if supported by the underlying query platform, which may impose it's own query timeout on queries regardless of this setting. If implemented, the query throws a QQueryTimeoutException when the query is aborted because it ran too long. When unset the value defaults to -1 which means "use the default timeout"; 0 means "no timeout at all"; all others is the timeout in seconds.

Parameters:

timeout -

fetch

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

Set a fetch strategy for a relation.

Parameters:

property -

strategy -

Returns:

getTestId

@Nullable
public String getTestId()

setTestId

public void setTestId(@Nullable
                      String testId)