com.qcadoo.model.api.search

Class SearchRestrictions

java.lang.Object

com.qcadoo.model.api.search.SearchRestrictions

@Component
public final class SearchRestrictions
extends Object

Utility with factory methods for SearchCriterion.

Since:

0.4.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchRestrictions.SearchMatchMode Match mode for "like" criterion.

Constructor Summary

Constructors

Constructor and Description
SearchRestrictions()

Method Summary

Modifier and Type	Method and Description
static SearchCriterion	allEq(Map<String,Object> values) Creates criterion which checks if all given fields match given values.
static SearchCriterion	and(SearchCriterion firstCriterion, SearchCriterion secondCriterion, SearchCriterion... otherCriteria) Creates restriction which join given restrictions with "AND" operator.
static SearchCriterion	belongsTo(String field, DataDefinition dataDefinition, long id) Creates criterion which checks if "belongsTo" field is equal to given entity.
static SearchCriterion	belongsTo(String field, Entity entity) Creates criterion which checks if "belongsTo" field is equal to given entity.
static SearchCriterion	belongsTo(String field, String pluginIdentifier, String modelName, long id) Creates criterion which checks if "belongsTo" field is equal to given entity.
static SearchCriterion	between(String field, Object lo, Object hi) Creates criterion which checks if field is between given values.
static SearchConjunction	conjunction() Creates conjunction - (...
static SearchDisjunction	disjunction() Creates disjunction - (...
static SearchCriterion	eq(String field, Object value) Creates criterion which checks if field is equal to given value.
static SearchCriterion	eqField(String field, String otherField) Creates criterion which checks if field is equal to other field.
static SearchCriterion	ge(String field, Object value) Creates criterion which checks if field is greater than or equal to given value.
static SearchCriterion	geField(String field, String otherField) Creates criterion which checks if field is greater than or equal to other field.
static SearchCriterion	gt(String field, Object value) Creates criterion which checks if field is greater than given value.
static SearchCriterion	gtField(String field, String otherField) Creates criterion which checks if field is greater than other field.
static SearchCriterion	idEq(long value) Creates criterion which checks if id is equal to given value.
static SearchCriterion	idNe(long value) Creates criterion which checks if id isn't equal to given value.
static SearchCriterion	iEq(String field, Object value) Creates criterion which checks if field is equal (using case-insensitive "eq" operator) to given value.
static SearchCriterion	ilike(String field, String value) Creates criterion which checks if field is equal (using case-insensitive "like" operator) to given value.
static SearchCriterion	ilike(String field, String value, SearchRestrictions.SearchMatchMode mode) Creates criterion which checks if field is equal (using case-insensitive "like" operator) to given value.
static SearchCriterion	in(String field, Collection<?> values) Creates criterion which checks if field is in given values.
static SearchCriterion	in(String field, Object... values) Creates criterion which checks if field is in given values.
static SearchCriterion	inIgnoringCase(String field, Collection<?> values) Creates criterion which checks if field is in given values ignoring case.
static SearchCriterion	isEmpty(String field) Creates criterion which checks if "collection" field's size is empty.
static SearchCriterion	isNotEmpty(String field) Creates criterion which checks if "collection" field's size isn't empty.
static SearchCriterion	isNotNull(String field) Creates criterion which checks if field is not null.
static SearchCriterion	isNull(String field) Creates criterion which checks if field is null.
static SearchCriterion	le(String field, Object value) Creates criterion which checks if field is less than or equal to given value.
static SearchCriterion	leField(String field, String otherField) Creates criterion which checks if field is less than or equal to other field.
static SearchCriterion	like(String field, String value) Creates criterion which checks if field is equal (using "like" operator) to given value.
static SearchCriterion	like(String field, String value, SearchRestrictions.SearchMatchMode mode) Creates criterion which checks if field is equal (using "like" operator) to given value.
static SearchCriterion	lt(String field, Object value) Creates criterion which checks if field is less than given value.
static SearchCriterion	ltField(String field, String otherField) Creates criterion which checks if field is less than other field.
static SearchCriterion	ne(String field, Object value) Creates criterion which checks if field isn't equal to given value.
static SearchCriterion	neField(String field, String otherField) Creates criterion which checks if field isn't equal to other field.
static SearchCriterion	not(SearchCriterion criterion) Wraps given criterion with "not" criterion.
static SearchCriterion	or(SearchCriterion firstCriterion, SearchCriterion secondCriterion, SearchCriterion... otherCriteria) Creates restriction which join given restrictions with "OR" operator.
static SearchCriterion	sizeEq(String field, int size) Creates criterion which checks if "collection" field's size is equal to given size.
static SearchCriterion	sizeGe(String field, int size) Creates criterion which checks if "collection" field's size is greater than or equal to given size.
static SearchCriterion	sizeGt(String field, int size) Creates criterion which checks if "collection" field's size is greater than given size.
static SearchCriterion	sizeLe(String field, int size) Creates criterion which checks if "collection" field's size is less than or equal to given size.
static SearchCriterion	sizeLt(String field, int size) Creates criterion which checks if "collection" field's size is less than given size.
static SearchCriterion	sizeNe(String field, int size) Creates criterion which checks if "collection" field's size isn't equal to given size.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchRestrictions

public SearchRestrictions()

Method Detail

allEq

public static SearchCriterion allEq(Map<String,Object> values)

Creates criterion which checks if all given fields match given values.

Parameters:

values - map where key is a field's name and value is the expected value

Returns:

criterion

and

public static SearchCriterion and(SearchCriterion firstCriterion,
                                  SearchCriterion secondCriterion,
                                  SearchCriterion... otherCriteria)

Creates restriction which join given restrictions with "AND" operator.

Parameters:

firstCriterion - first criterion

secondCriterion - second criterion

otherCriteria - other criteria

Returns:

criterion

belongsTo

public static SearchCriterion belongsTo(String field,
                                        DataDefinition dataDefinition,
                                        long id)

Creates criterion which checks if "belongsTo" field is equal to given entity. Current implementation of this method performs Entity loading and may cause StackOverflowError when used (for example) within onView hook. Therefore prefer belongsTo(String, Entity) and use this method only in case when you can't obtain reference to a whole Entity.

Parameters:

field - field

dataDefinition - data's definition

id - id

Returns:

criterion

belongsTo

public static SearchCriterion belongsTo(String field,
                                        Entity entity)

Creates criterion which checks if "belongsTo" field is equal to given entity.

Parameters:

field - field

entity - entity

Returns:

criterion

belongsTo

public static SearchCriterion belongsTo(String field,
                                        String pluginIdentifier,
                                        String modelName,
                                        long id)

Creates criterion which checks if "belongsTo" field is equal to given entity. Current implementation of this method performs Entity loading and may cause StackOverflowError when used (for example) within onView hook. Therefore prefer belongsTo(String, Entity) and use this method only in case when you can't obtain reference to a whole Entity.

Parameters:

field - field

pluginIdentifier - plugin's identifier

modelName - model's name

id - id

Returns:

criterion

between

public static SearchCriterion between(String field,
                                      Object lo,
                                      Object hi)

Creates criterion which checks if field is between given values.

Parameters:

field - field

lo - low value

hi - high value

Returns:

criterion

conjunction

public static SearchConjunction conjunction()

Creates conjunction - (... AND ... AND ...).

Returns:

conjunction

disjunction

public static SearchDisjunction disjunction()

Creates disjunction - (... OR ... OR ...).

Returns:

disjunction

eq

public static SearchCriterion eq(String field,
                                 Object value)

Creates criterion which checks if field is equal to given value.

Parameters:

field - field

value - value

Returns:

criterion

eqField

public static SearchCriterion eqField(String field,
                                      String otherField)

Creates criterion which checks if field is equal to other field.

Parameters:

field - field

otherField - other field

Returns:

criterion

ge

public static SearchCriterion ge(String field,
                                 Object value)

Creates criterion which checks if field is greater than or equal to given value.

Parameters:

field - field

value - value

Returns:

criterion

geField

public static SearchCriterion geField(String field,
                                      String otherField)

Creates criterion which checks if field is greater than or equal to other field.

Parameters:

field - field

otherField - other field

Returns:

criterion

gt

public static SearchCriterion gt(String field,
                                 Object value)

Creates criterion which checks if field is greater than given value.

Parameters:

field - field

value - value

Returns:

criterion

gtField

public static SearchCriterion gtField(String field,
                                      String otherField)

Creates criterion which checks if field is greater than other field.

Parameters:

field - field

otherField - other field

Returns:

criterion

idEq

public static SearchCriterion idEq(long value)

Creates criterion which checks if id is equal to given value.

Parameters:

value - value

Returns:

criterion

idNe

public static SearchCriterion idNe(long value)

Creates criterion which checks if id isn't equal to given value.

Parameters:

value - value

Returns:

criterion

iEq

public static SearchCriterion iEq(String field,
                                  Object value)

Creates criterion which checks if field is equal (using case-insensitive "eq" operator) to given value.

Parameters:

field - field

value - value

Returns:

criterion

ilike

public static SearchCriterion ilike(String field,
                                    String value)

Creates criterion which checks if field is equal (using case-insensitive "like" operator) to given value.

Parameters:

field - field

value - value

Returns:

criterion

ilike

public static SearchCriterion ilike(String field,
                                    String value,
                                    SearchRestrictions.SearchMatchMode mode)

Creates criterion which checks if field is equal (using case-insensitive "like" operator) to given value.

Parameters:

field - field

mode - match mode

value - value

Returns:

criterion

in

public static SearchCriterion in(String field,
                                 Collection<?> values)

Creates criterion which checks if field is in given values.

Parameters:

field - field

values - values

Returns:

criterion

in

public static SearchCriterion in(String field,
                                 Object... values)

Creates criterion which checks if field is in given values.

Parameters:

field - field

values - values

Returns:

criterion

inIgnoringCase

public static SearchCriterion inIgnoringCase(String field,
                                             Collection<?> values)

Creates criterion which checks if field is in given values ignoring case.

Parameters:

field - field

values - values

Returns:

criterion

isEmpty

public static SearchCriterion isEmpty(String field)

Creates criterion which checks if "collection" field's size is empty.

Parameters:

field - field

Returns:

criterion

isNotEmpty

public static SearchCriterion isNotEmpty(String field)

Creates criterion which checks if "collection" field's size isn't empty.

Parameters:

field - field

Returns:

criterion

isNotNull

public static SearchCriterion isNotNull(String field)

Creates criterion which checks if field is not null.

Parameters:

field - field

Returns:

criterion

isNull

public static SearchCriterion isNull(String field)

Creates criterion which checks if field is null.

Parameters:

field - field

Returns:

criterion

le

public static SearchCriterion le(String field,
                                 Object value)

Creates criterion which checks if field is less than or equal to given value.

Parameters:

field - field

value - value

Returns:

criterion

leField

public static SearchCriterion leField(String field,
                                      String otherField)

Creates criterion which checks if field is less than or equal to other field.

Parameters:

field - field

otherField - other field

Returns:

criterion

like

public static SearchCriterion like(String field,
                                   String value)

Creates criterion which checks if field is equal (using "like" operator) to given value.

Parameters:

field - field

value - value

Returns:

criterion

like

public static SearchCriterion like(String field,
                                   String value,
                                   SearchRestrictions.SearchMatchMode mode)

Creates criterion which checks if field is equal (using "like" operator) to given value.

Parameters:

field - field

mode - match mode

value - value

Returns:

criterion

lt

public static SearchCriterion lt(String field,
                                 Object value)

Creates criterion which checks if field is less than given value.

Parameters:

field - field

value - value

Returns:

criterion

ltField

public static SearchCriterion ltField(String field,
                                      String otherField)

Creates criterion which checks if field is less than other field.

Parameters:

field - field

otherField - other field

Returns:

criterion

ne

public static SearchCriterion ne(String field,
                                 Object value)

Creates criterion which checks if field isn't equal to given value.

Parameters:

field - field

value - value

Returns:

criterion

neField

public static SearchCriterion neField(String field,
                                      String otherField)

Creates criterion which checks if field isn't equal to other field.

Parameters:

field - field

otherField - other field

Returns:

criterion

not

public static SearchCriterion not(SearchCriterion criterion)

Wraps given criterion with "not" criterion.

Parameters:

criterion - criterion

Returns:

negated criterion

or

public static SearchCriterion or(SearchCriterion firstCriterion,
                                 SearchCriterion secondCriterion,
                                 SearchCriterion... otherCriteria)

Creates restriction which join given restrictions with "OR" operator.

Parameters:

firstCriterion - first criterion

secondCriterion - second criterion

otherCriteria - other criteria

Returns:

criterion

sizeEq

public static SearchCriterion sizeEq(String field,
                                     int size)

Creates criterion which checks if "collection" field's size is equal to given size.

Parameters:

field - field

size - size

Returns:

criterion

sizeGe

public static SearchCriterion sizeGe(String field,
                                     int size)

Creates criterion which checks if "collection" field's size is greater than or equal to given size.

Parameters:

field - field

size - size

Returns:

criterion

sizeGt

public static SearchCriterion sizeGt(String field,
                                     int size)

Creates criterion which checks if "collection" field's size is greater than given size.

Parameters:

field - field

size - size

Returns:

criterion

sizeLe

public static SearchCriterion sizeLe(String field,
                                     int size)

Creates criterion which checks if "collection" field's size is less than or equal to given size.

Parameters:

field - field

size - size

Returns:

criterion

sizeLt

public static SearchCriterion sizeLt(String field,
                                     int size)

Creates criterion which checks if "collection" field's size is less than given size.

Parameters:

field - field

size - size

Returns:

criterion

sizeNe

public static SearchCriterion sizeNe(String field,
                                     int size)

Creates criterion which checks if "collection" field's size isn't equal to given size.

Parameters:

field - field

size - size

Returns:

criterion