QRestrictor (domui :: webapp-core 1.1 API)

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

Direct Known Subclasses:

QCriteriaQueryBase
```
public abstract class QRestrictor<T>
extends Object
```
Builds the "where" part of a query, or a part of that "where" part, under construction. The nodes added, when > 1, are combined using either OR or AND.

Author:

Frits Jalvingh Created on Dec 22, 2009

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`QRestrictor(Class<T> baseClass, QOperation combinator)`
`protected`	`QRestrictor(ICriteriaTableDef<T> meta, QOperation combinator)`
`protected`	`QRestrictor(QRestrictor<T> parent, QOperation combinator)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`QRestrictor<T>`	`add(QOperatorNode n)`
`QRestrictor<T>`	`and()`
`QRestrictor<T>`	`between(String property, Object a, Object b)` Compare the value of a property with two literal bounds.
`<V,R extends QField<R,T>> QRestrictor<T>`	`eq(QField<R,V> property, V value)` Compare a property with some value.
`<R extends QField<R,T>> QRestrictor<T>`	`eq(QFieldDouble<R> property, double value)`
`QRestrictor<T>`	`eq(String property, double value)` Compare a property with some literal object value.
`QRestrictor<T>`	`eq(String property, long value)` Compare a property with some literal object value.
`QRestrictor<T>`	`eq(String property, Object value)` Compare a property with some literal object value.
`<U> QRestrictor<U>`	`exists(Class<U> childclass, String childproperty)` Create a joined "exists" subquery on some child list property.
`<P extends QField<P,T>,R extends QField<R,U>,U> QRestrictor<U>`	`exists(QList<P,R> listProperty)`
`QRestrictor<T>`	`ge(String property, double value)` Compare a property with some literal object value.
`QRestrictor<T>`	`ge(String property, long value)` Compare a property with some literal object value.
`QRestrictor<T>`	`ge(String property, Object value)` Compare a property with some literal object value.
`Class<T>`	`getBaseClass()` Returns the persistent class being queried and returned, if this is a class-based query.
`ICriteriaTableDef<T>`	`getMetaTable()` Returns the metatable being queried, or null.
`abstract QOperatorNode`	`getRestrictions()`
`Class<T>`	`getReturnClass()` Return the datatype returned by a principal query using this criteria.
`Set<QSubQuery<?,?>>`	`getUnusedSubquerySet()` Internal method, used to be able to find QSubQueries that were allocated (using `subquery(Class)` but not properly linked back into the main query.
`QRestrictor<T>`	`gt(String property, double value)` Compare a property with some literal object value.
`QRestrictor<T>`	`gt(String property, long value)` Compare a property with some literal object value.
`QRestrictor<T>`	`gt(String property, Object value)` Compare a property with some literal object value.
`boolean`	`hasRestrictions()` Returns T if this has restrictions.
`QRestrictor<T>`	`ilike(String property, Object value)` Do a case-independent 'like' comparison.
`<V,R extends QField<R,T>> QRestrictor<T>`	`in(QField<R,V> property, List<V> value)` A property must be one of a list of values.
`<V> QRestrictor<T>`	`in(String property, List<V> inlist)` A property must be one of a list of values.
`<V> QRestrictor<T>`	`in(String property, QSelection<?> selection)`
`protected void`	`internalAdd(QOperatorNode r)` Add a new restriction to the list of restrictions on the data.
`void`	`internalUseQuery(QSubQuery<?,?> q)` See `getUnusedSubquerySet()`
`QRestrictor<T>`	`isnotnull(String property)` Add the restriction that the property specified must be not-null.
`QRestrictor<T>`	`isnull(String property)` Add the restriction that the property specified must be null.
`QRestrictor<T>`	`le(String property, double value)` Compare a property with some literal object value.
`QRestrictor<T>`	`le(String property, long value)` Compare a property with some literal object value.
`QRestrictor<T>`	`le(String property, Object value)` Compare a property with some literal object value.
`QRestrictor<T>`	`like(String property, Object value)` Do a 'like' comparison.
`QRestrictor<T>`	`lt(String property, double value)` Compare a property with some literal object value.
`QRestrictor<T>`	`lt(String property, long value)` Compare a property with some literal object value.
`QRestrictor<T>`	`lt(String property, Object value)` Compare a property with some literal object value.
`void`	`mergeCriteria(QRestrictor<T> other)` This merges the "other" restrictor's restrictions inside this restriction.
`<V,R extends QField<R,T>> QRestrictor<T>`	`ne(QField<R,V> property, V value)` Compare a property with some value.
`QRestrictor<T>`	`ne(String property, double value)` Compare a property with some literal object value.
`QRestrictor<T>`	`ne(String property, long value)` Compare a property with some literal object value.
`QRestrictor<T>`	`ne(String property, Object value)` Compare a property with some literal object value.
`QRestrictor<T>`	`not()` Add NOT restriction.
`QRestrictor<T>`	`or()` Return a thingy that constructs nodes combined with "or".
`QRestrictor<T>`	`or(QOperatorNode a1, QOperatorNode a2, QOperatorNode... rest)` Deprecated.
`abstract void`	`setRestrictions(QOperatorNode n)`
`QRestrictor<T>`	`sqlCondition(String sql)` Add a restriction specified in bare SQL.
`QRestrictor<T>`	`sqlCondition(String sql, Object[] params)` Add a restriction in bare SQL, with JDBC parameters inside the string (specified as '?').
`<U> QSubQuery<U,T>`	`subquery(Class<U> childClass)`

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

Constructor Detail

QRestrictor

protected QRestrictor(@Nonnull
                      Class<T> baseClass,
                      @Nonnull
                      QOperation combinator)

QRestrictor

protected QRestrictor(@Nonnull
                      ICriteriaTableDef<T> meta,
                      @Nonnull
                      QOperation combinator)

QRestrictor

protected QRestrictor(@Nonnull
                      QRestrictor<T> parent,
                      @Nonnull
                      QOperation combinator)

Method Detail

getRestrictions

@Nullable
public abstract QOperatorNode getRestrictions()

setRestrictions

public abstract void setRestrictions(@Nullable
                                     QOperatorNode n)

getBaseClass
```
@Nullable
public Class<T> getBaseClass()
```
Returns the persistent class being queried and returned, if this is a class-based query.

Returns:

getMetaTable
```
@Nullable
public ICriteriaTableDef<T> getMetaTable()
```
Returns the metatable being queried, or null.

Returns:

getReturnClass
```
@Nonnull
public Class<T> getReturnClass()
```
Return the datatype returned by a principal query using this criteria.

Returns:

hasRestrictions
```
public final boolean hasRestrictions()
```
Returns T if this has restrictions.

internalAdd
```
protected void internalAdd(@Nonnull
                           QOperatorNode r)
```
Add a new restriction to the list of restrictions on the data. This will do "and" collapsing: when the node added is an "and" it's nodes will be added directly to the list (because that already represents an and combinatory).

Parameters:

r -

or
```
@Nonnull
public QRestrictor<T> or()
```
Return a thingy that constructs nodes combined with "or".

Returns:

and
```
@Nonnull
public QRestrictor<T> and()
```

not
```
@Nonnull
public QRestrictor<T> not()
```
Add NOT restriction.

Returns:

mergeCriteria
```
public void mergeCriteria(@Nonnull
                          QRestrictor<T> other)
```
This merges the "other" restrictor's restrictions inside this restriction. Both restrictions are merged by using an "and" between both complete sets. Only "this" restriction is altered; the original is kept as-is (the nodes are copied).

Parameters:

other -

add

@Nonnull
public QRestrictor<T> add(@Nonnull
                                   QOperatorNode n)

eq

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

eq

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

Compare a property with some value.

Parameters:: property -; value -
Returns:

ne

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

Compare a property with some value.

Parameters:: property -; value -
Returns:

eq

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

eq

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

ne

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

ne

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

ne

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

in

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

A property must be one of a list of values.

Type Parameters:: V -
Parameters:: property -; inlist -
Returns:

in

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

in

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

A property must be one of a list of values.

gt

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

gt

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

gt

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

lt

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

lt

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

lt

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

ge

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

ge

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

ge

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

le

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

le

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

le

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

Compare a property with some literal object value.

Parameters:: property -; value -
Returns:

like

@Nonnull
public QRestrictor<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.

Parameters:: property -; value -
Returns:

between

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

Compare the value of a property with two literal bounds.

Parameters:: property -; a -; b -
Returns:

ilike

@Nonnull
public QRestrictor<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.

Parameters:: property -; value -
Returns:

or

@Deprecated
 @Nonnull
public QRestrictor<T> or(@Nonnull
                                               QOperatorNode a1,
                                               @Nonnull
                                               QOperatorNode a2,
                                               @Nonnull
                                               QOperatorNode... rest)

Deprecated.

Add a set of OR nodes to the set.

Parameters:: a -
Returns:

isnull

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

Add the restriction that the property specified must be null.

Parameters:: property -
Returns:

isnotnull

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

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

Parameters:: property -
Returns:

sqlCondition

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

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

Parameters:: sql -
Returns:

sqlCondition
```
@Nonnull
public QRestrictor<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.

Parameters:

sql -

params -

Returns:

exists
```
@Nonnull
public <U> QRestrictor<U> exists(@Nonnull
                                          Class<U> childclass,
                                          @Nonnull
                                          String childproperty)
```
Create a joined "exists" subquery on some child list property. The parameters passed have a relation with eachother; this relation cannot be checked at compile time because Java still lacks property references (Sun is still too utterly stupid to define them). They will be checked at runtime when the query is executed.

Type Parameters:

U - The type of the children.

Parameters:

childclass - The class type of the children, because Java Generics is too bloody stupid to find out itself.

childproperty - The name of the property in the parent class that represents the List of child records.

Returns:

exists

@Nonnull
public <P extends QField<P,T>,R extends QField<R,U>,U> QRestrictor<U> exists(@Nonnull
                                                                                      QList<P,R> listProperty)
                                                                               throws Exception

Throws:: Exception

eq

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

subquery

public <U> QSubQuery<U,T> subquery(@Nonnull
                                   Class<U> childClass)
                            throws Exception

Throws:: Exception

getUnusedSubquerySet
```
public Set<QSubQuery<?,?>> getUnusedSubquerySet()
```
Internal method, used to be able to find QSubQueries that were allocated (using subquery(Class) but not properly linked back into the main query. That is, if you create a correlated subquery like (select max(date) from xxx where xxx.id=parent.id) and you do not use that subquery inside the parent (select * from yyy where yyy.date = (subquery)) then the subquery is "lost". This leads to unexpected results as the user assumes the subquery does something. Registering all subqueries created here allows any querying visitor to implement a check: it should remove all subqueries that it actually encounters and handles, and after that it checks to ensure that this set is empty. If not there are subqueries left that were not joined back.

Returns:

internalUseQuery
```
public void internalUseQuery(QSubQuery<?,?> q)
```
See getUnusedSubquerySet()

Parameters:

q -

Class QRestrictor<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QRestrictor

QRestrictor

QRestrictor

Method Detail

getRestrictions

setRestrictions

getBaseClass

getMetaTable

getReturnClass

hasRestrictions

internalAdd

or

and

not

mergeCriteria

add

eq

eq

ne

eq

eq

ne

ne

ne

in

in

in

gt

gt

gt

lt

lt

lt

ge

ge

ge

le

le

le

like

between

ilike

or

isnull

isnotnull

sqlCondition

sqlCondition

exists

exists

eq

subquery

getUnusedSubquerySet

internalUseQuery