sirius.db.jdbc.constraints

Class SQLFilterFactory

java.lang.Object

sirius.db.mixing.query.constraints.FilterFactory<SQLConstraint>

sirius.db.jdbc.constraints.SQLFilterFactory

public class SQLFilterFactory
extends FilterFactory<SQLConstraint>

Generates filters and constraints for SmartQuery.

See Also:

OMA.FILTERS

Constructor Summary

Constructors

Constructor and Description
SQLFilterFactory()

Method Summary

Modifier and Type	Method and Description
protected Object	customTransform(Object value) Permits to provive database dependent transformations.
protected SQLConstraint	effectiveAnd(List<SQLConstraint> effectiveConstraints) Combines the list of constraints using AND
protected SQLConstraint	effectiveOr(List<SQLConstraint> effectiveConstraints) Combines the list of constraints using OR
protected SQLConstraint	eqValue(Mapping field, Object value) Represents field = value as constraint
Exists	existsIn(Mapping outerColumn, Class<? extends SQLEntity> other, Mapping innerColumn) Generates an EXISTS clause: EXISTS(SELECT * FROM other WHERE e.outerColumn = other.innerColumn.
SQLConstraint	filled(Mapping field) Generates a constraint which ensures that the given field is filled (not null)
protected SQLConstraint	gtValue(Mapping field, Object value, boolean orEqual) Represents field > value as constraint
protected SQLConstraint	invert(SQLConstraint constraint) Effectively inverts the given constraint
Like	like(Mapping fields) Creates a LIKE constraint for the given field.
protected SQLConstraint	ltValue(Mapping field, Object value, boolean orEqual) Represents field < value as constraint
protected SQLConstraint	neValue(Mapping field, Object value) Represents field !
SQLConstraint	notFilled(Mapping field) Generates a constraint which ensures that the given field is not filled (null)
SQLConstraint	queryString(EntityDescriptor descriptor, String query, List<QueryField> fields) Compiles the given query for the given entity while searching in the given fields.

Methods inherited from class sirius.db.mixing.query.constraints.FilterFactory

and, and, containsAll, containsAny, containsNone, containsOne, eq, eqIgnoreEmpty, eqOrEmpty, gt, gte, gteOrEmpty, gtOrEmpty, lt, lte, lteOrEmpty, ltOrEmpty, ne, noneInField, not, oneInField, or, or, queryString, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

SQLFilterFactory

public SQLFilterFactory()

Method Detail

customTransform

protected Object customTransform(Object value)

Description copied from class: FilterFactory

Permits to provive database dependent transformations.

Specified by:

customTransform in class FilterFactory<SQLConstraint>

Parameters:

value - the value to tranform

Returns:

the transformed value

eqValue

protected SQLConstraint eqValue(Mapping field,
                                Object value)

Description copied from class: FilterFactory

Represents field = value as constraint

Specified by:

eqValue in class FilterFactory<SQLConstraint>

Parameters:

field - the field to filter

value - the value to filter with

Returns:

the generated constraint

neValue

protected SQLConstraint neValue(Mapping field,
                                Object value)

Description copied from class: FilterFactory

Represents field != value as constraint

Specified by:

neValue in class FilterFactory<SQLConstraint>

Parameters:

field - the field to filter

value - the value to filter with

Returns:

the generated constraint

gtValue

protected SQLConstraint gtValue(Mapping field,
                                Object value,
                                boolean orEqual)

Description copied from class: FilterFactory

Represents field > value as constraint

Specified by:

gtValue in class FilterFactory<SQLConstraint>

Parameters:

field - the field to filter

value - the value to filter with

orEqual - if true, field >= value is used as comparator

Returns:

the generated constraint

ltValue

protected SQLConstraint ltValue(Mapping field,
                                Object value,
                                boolean orEqual)

Description copied from class: FilterFactory

Represents field < value as constraint

Specified by:

ltValue in class FilterFactory<SQLConstraint>

Parameters:

field - the field to filter

value - the value to filter with

orEqual - if true, field <= value is used as comparator

Returns:

the generated constraint

filled

public SQLConstraint filled(Mapping field)

Description copied from class: FilterFactory

Generates a constraint which ensures that the given field is filled (not null)

Specified by:

filled in class FilterFactory<SQLConstraint>

Parameters:

field - the field to check

Returns:

the generated constraint

notFilled

public SQLConstraint notFilled(Mapping field)

Description copied from class: FilterFactory

Generates a constraint which ensures that the given field is not filled (null)

Specified by:

notFilled in class FilterFactory<SQLConstraint>

Parameters:

field - the field to check

Returns:

the generated constraint

invert

protected SQLConstraint invert(SQLConstraint constraint)

Description copied from class: FilterFactory

Effectively inverts the given constraint

Specified by:

invert in class FilterFactory<SQLConstraint>

Parameters:

constraint - the constraint to invert

Returns:

the inverted constraint

effectiveAnd

protected SQLConstraint effectiveAnd(List<SQLConstraint> effectiveConstraints)

Description copied from class: FilterFactory

Combines the list of constraints using AND

Specified by:

effectiveAnd in class FilterFactory<SQLConstraint>

Parameters:

effectiveConstraints - the constraints to combine (where each value will be non-null)

Returns:

the combined constraint

effectiveOr

protected SQLConstraint effectiveOr(List<SQLConstraint> effectiveConstraints)

Description copied from class: FilterFactory

Combines the list of constraints using OR

Specified by:

effectiveOr in class FilterFactory<SQLConstraint>

Parameters:

effectiveConstraints - the constraints to combine (where each value will be non-null)

Returns:

the combined constraint

queryString

public SQLConstraint queryString(EntityDescriptor descriptor,
                                 String query,
                                 List<QueryField> fields)

Description copied from class: FilterFactory

Compiles the given query for the given entity while searching in the given fields.

Specified by:

queryString in class FilterFactory<SQLConstraint>

Parameters:

descriptor - the descriptor of the entity being searched

query - the query to compile

fields - the default fields to search in

Returns:

a constraint representing the compiled query

existsIn

public Exists existsIn(Mapping outerColumn,
                       Class<? extends SQLEntity> other,
                       Mapping innerColumn)

Generates an EXISTS clause: EXISTS(SELECT * FROM other WHERE e.outerColumn = other.innerColumn.

Parameters:

outerColumn - the column of the entities being queried to match

other - the entity type to search in (which must exist)

innerColumn - the column within that inner entity type which must match the outer column

Returns:

an exists constraint which can be filtered with additional constraints

like

public Like like(Mapping fields)

Creates a LIKE constraint for the given field.

Parameters:

fields - the field to search in

Returns:

a builder used to construct a LIKE constraint