sirius.db.mixing.query.constraints

Class FilterFactory<C extends Constraint>

java.lang.Object

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

Type Parameters:

C - the type of constraints being created

Direct Known Subclasses:

ElasticFilterFactory, MongoFilterFactory, SQLFilterFactory

public abstract class FilterFactory<C extends Constraint>
extends Object

Defines a factory to create common filters or constraints to be used in a Query.

Constructor Summary

Constructors

Constructor and Description
FilterFactory()

Method Summary

Modifier and Type	Method and Description
C	and(C... constraints) Combines the list of constraints using AND
C	and(List<C> constraints) Combines the list of constraints using AND
CSVFilter<C>	containsAll(Mapping field, sirius.kernel.commons.Value commaSeparatedValues) Creates a new constraint for the given field which asserts that all of the given values in the string is present.
CSVFilter<C>	containsAny(Mapping field, sirius.kernel.commons.Value commaSeparatedValues) Creates a new constraint for the given field which asserts that one of the given values in the string is present.
C	containsNone(Mapping field, Object... values) Creates a constraint which ensures that the given field doesn't contain any of the given values.
OneInField<C>	containsOne(Mapping field, Object... values) Creates a filter builder which ensures that the given field contains at least on of the given values.
protected abstract Object	customTransform(Object value) Permits to provive database dependent transformations.
protected abstract C	effectiveAnd(List<C> effectiveConstraints) Combines the list of constraints using AND
protected abstract C	effectiveOr(List<C> effectiveConstraints) Combines the list of constraints using OR
C	eq(Mapping field, Object value) Represents field = value as constraint
C	eqIgnoreEmpty(Mapping field, Object value) Represents field = value as constraint However, if the value is null, no constraint will be generated.
C	eqOrEmpty(Mapping field, Object value) Represents field = value OR empty(field) as constraint
protected abstract C	eqValue(Mapping field, Object value) Represents field = value as constraint
abstract C	filled(Mapping field) Generates a constraint which ensures that the given field is filled (not null)
C	gt(Mapping field, Object value) Represents field > value as constraint
C	gte(Mapping field, Object value) Represents field >= value as constraint
C	gteOrEmpty(Mapping field, Object value) Represents field >= value OR empty(field) as constraint
C	gtOrEmpty(Mapping field, Object value) Represents field > value OR empty(field) as constraint
protected abstract C	gtValue(Mapping field, Object value, boolean orEqual) Represents field > value as constraint
protected abstract C	invert(C constraint) Effectively inverts the given constraint
C	lt(Mapping field, Object value) Represents field < value as constraint
C	lte(Mapping field, Object value) Represents field <= value as constraint
C	lteOrEmpty(Mapping field, Object value) Represents field <= OR empty(field) value as constraint
C	ltOrEmpty(Mapping field, Object value) Represents field < OR empty(field) value as constraint
protected abstract C	ltValue(Mapping field, Object value, boolean orEqual) Represents field < value as constraint
C	ne(Mapping field, Object value) Represents field !
protected abstract C	neValue(Mapping field, Object value) Represents field !
C	noneInField(Mapping field, List<Object> values) Creates a constraint which ensures that the given field doesn't contain any of the given values.
C	not(C constraint) Inverts the given constraint.
abstract C	notFilled(Mapping field) Generates a constraint which ensures that the given field is not filled (null)
OneInField<C>	oneInField(Mapping field, List<Object> values) Creates a filter builder which ensures that the given field contains at least on of the given values.
C	or(C... constraints) Combines the list of constraints using OR
C	or(List<C> constraints) Combines the list of constraints using OR
abstract C	queryString(EntityDescriptor descriptor, String query, List<QueryField> fields) Compiles the given query for the given entity while searching in the given fields.
C	queryString(EntityDescriptor descriptor, String query, QueryField... fields) Compiles the given query for the given entity while searching in the given fields.
Object	transform(Object value) Transforms a given value into the representation expected by the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterFactory

public FilterFactory()

Method Detail

transform

public Object transform(Object value)

Transforms a given value into the representation expected by the database.

Parameters:

value - the value to tranform

Returns:

the transformed value

customTransform

protected abstract Object customTransform(Object value)

Permits to provive database dependent transformations.

Parameters:

value - the value to tranform

Returns:

the transformed value

eq

public C eq(Mapping field,
            @Nullable
            Object value)

Represents field = value as constraint

Parameters:

field - the field to filter

value - the value to filter with

Returns:

the generated constraint

eqValue

protected abstract C eqValue(Mapping field,
                             @Nonnull
                             Object value)

Represents field = value as constraint

Parameters:

field - the field to filter

value - the value to filter with

Returns:

the generated constraint

eqIgnoreEmpty

@Nullable
public C eqIgnoreEmpty(Mapping field,
                                 Object value)

Represents field = value as constraint

However, if the value is null, no constraint will be generated.

Parameters:

field - the field to filter

value - the value to filter with

Returns:

the generated constraint

eqOrEmpty

public C eqOrEmpty(Mapping field,
                   Object value)

Represents field = value OR empty(field) as constraint

Parameters:

field - the field to filter

value - the value to filter with

Returns:

the generated constraint

ne

public C ne(Mapping field,
            @Nullable
            Object value)

Represents field != value as constraint

Parameters:

field - the field to filter

value - the value to filter with

Returns:

the generated constraint

neValue

protected abstract C neValue(Mapping field,
                             @Nonnull
                             Object value)

Represents field != value as constraint

Parameters:

field - the field to filter

value - the value to filter with

Returns:

the generated constraint

gt

@Nullable
public C gt(Mapping field,
                      @Nullable
                      Object value)

Represents field > value as constraint

Parameters:

field - the field to filter

value - the value to filter with. If null is passed in, no constraint is generated

Returns:

the generated constraint

gtValue

@Nonnull
protected abstract C gtValue(Mapping field,
                                      @Nonnull
                                      Object value,
                                      boolean orEqual)

Represents field > value as constraint

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

gtOrEmpty

@Nullable
public C gtOrEmpty(Mapping field,
                             @Nullable
                             Object value)

Represents field > value OR empty(field) as constraint

Parameters:

field - the field to filter

value - the value to filter with. If null is passed in, no constraint is generated

Returns:

the generated constraint

gte

@Nullable
public C gte(Mapping field,
                       @Nullable
                       Object value)

Represents field >= value as constraint

Parameters:

field - the field to filter

value - the value to filter with. If null is passed in, no constraint is generated

Returns:

the generated constraint

gteOrEmpty

@Nullable
public C gteOrEmpty(Mapping field,
                              @Nullable
                              Object value)

Represents field >= value OR empty(field) as constraint

Parameters:

field - the field to filter

value - the value to filter with. If null is passed in, no constraint is generated

Returns:

the generated constraint

lt

@Nullable
public C lt(Mapping field,
                      @Nullable
                      Object value)

Represents field < value as constraint

Parameters:

field - the field to filter

value - the value to filter with. If null is passed in, no constraint is generated

Returns:

the generated constraint

ltValue

@Nonnull
protected abstract C ltValue(Mapping field,
                                      @Nonnull
                                      Object value,
                                      boolean orEqual)

Represents field < value as constraint

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

ltOrEmpty

@Nullable
public C ltOrEmpty(Mapping field,
                             @Nullable
                             Object value)

Represents field < OR empty(field) value as constraint

Parameters:

field - the field to filter

value - the value to filter with. If null is passed in, no constraint is generated

Returns:

the generated constraint

lte

@Nullable
public C lte(Mapping field,
                       @Nullable
                       Object value)

Represents field <= value as constraint

Parameters:

field - the field to filter

value - the value to filter with. If null is passed in, no constraint is generated

Returns:

the generated constraint

lteOrEmpty

@Nullable
public C lteOrEmpty(Mapping field,
                              @Nullable
                              Object value)

Represents field <= OR empty(field) value as constraint

Parameters:

field - the field to filter

value - the value to filter with. If null is passed in, no constraint is generated

Returns:

the generated constraint

filled

public abstract C filled(Mapping field)

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

Parameters:

field - the field to check

Returns:

the generated constraint

notFilled

public abstract C notFilled(Mapping field)

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

Parameters:

field - the field to check

Returns:

the generated constraint

not

@Nullable
public C not(@Nullable
                       C constraint)

Inverts the given constraint.

Parameters:

constraint - the constraint to invert.

Returns:

the inverted constraint

invert

@Nonnull
protected abstract C invert(@Nonnull
                                     C constraint)

Effectively inverts the given constraint

Parameters:

constraint - the constraint to invert

Returns:

the inverted constraint

and

@Nullable
public final C and(List<C> constraints)

Combines the list of constraints using AND

Parameters:

constraints - the constraints to combine

Returns:

the combined constraint

and

@Nullable
 @SafeVarargs
public final C and(C... constraints)

Combines the list of constraints using AND

Parameters:

constraints - the constraints to combine

Returns:

the combined constraint

effectiveAnd

@Nonnull
protected abstract C effectiveAnd(List<C> effectiveConstraints)

Combines the list of constraints using AND

Parameters:

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

Returns:

the combined constraint

or

@Nullable
public final C or(List<C> constraints)

Combines the list of constraints using OR

Parameters:

constraints - the constraints to combine

Returns:

the combined constraint

or

@Nullable
 @SafeVarargs
public final C or(C... constraints)

Combines the list of constraints using OR

Parameters:

constraints - the constraints to combine

Returns:

the combined constraint

effectiveOr

@Nonnull
protected abstract C effectiveOr(List<C> effectiveConstraints)

Combines the list of constraints using OR

Parameters:

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

Returns:

the combined constraint

containsOne

public OneInField<C> containsOne(Mapping field,
                                 Object... values)

Creates a filter builder which ensures that the given field contains at least on of the given values.

Parameters:

field - the field to filter on

values - the values to check

Returns:

a filter builder used to generate a constraint

oneInField

public OneInField<C> oneInField(Mapping field,
                                List<Object> values)

Creates a filter builder which ensures that the given field contains at least on of the given values.

Parameters:

field - the field to filter on

values - the values to check

Returns:

a filter builder used to generate a constraint

containsNone

public C containsNone(Mapping field,
                      Object... values)

Creates a constraint which ensures that the given field doesn't contain any of the given values.

Parameters:

field - the field to filter on

values - the values to check

Returns:

the generated constraint

noneInField

public C noneInField(Mapping field,
                     List<Object> values)

Creates a constraint which ensures that the given field doesn't contain any of the given values.

Parameters:

field - the field to filter on

values - the values to check

Returns:

the generated constraint

containsAny

public CSVFilter<C> containsAny(Mapping field,
                                sirius.kernel.commons.Value commaSeparatedValues)

Creates a new constraint for the given field which asserts that one of the given values in the string is present.

The string can have a form like A,B,C or A|B|C.

Parameters:

field - the field to check

commaSeparatedValues - the comma separated values to check for

Returns:

a new constraint representing the given filter setting

containsAll

public CSVFilter<C> containsAll(Mapping field,
                                sirius.kernel.commons.Value commaSeparatedValues)

Creates a new constraint for the given field which asserts that all of the given values in the string is present.

The string can have a form like A,B,C or A|B|C.

Parameters:

field - the field to check

commaSeparatedValues - the comma separated values to check for

Returns:

a new constraint representing the given filter setting

queryString

public C queryString(EntityDescriptor descriptor,
                     String query,
                     QueryField... fields)

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

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

queryString

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

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

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