sirius.db.mixing.query

Class QueryField

java.lang.Object

sirius.db.mixing.query.QueryField

public class QueryField
extends Object

Annotates a field to be used in FilterFactory.queryString(EntityDescriptor, String, QueryField...).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryField.Mode Determines the way, the filter value can be applied to a given field.

Method Summary

Modifier and Type	Method and Description
static QueryField	contains(Mapping field) Informs the compiler, that by default a fully expanding search like a contains query may be generated for this field.
static QueryField	eq(Mapping field) Informs the compiler, that only real equality checks are permitted for this field.
Mapping	getField()
QueryField.Mode	getMode()
static QueryField	like(Mapping field) Informs the compiler, that by default, equality checks are used for this field.
static QueryField	startsWith(Mapping field) Informs the compiler, that by default an expanding search like a prefix query may be generated for this field.

Methods inherited from class java.lang.Object

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

Method Detail

eq

public static QueryField eq(Mapping field)

Informs the compiler, that only real equality checks are permitted for this field.

This ensures that a proper database index can be used for all queries.

Parameters:

field - the field to search in

Returns:

the generated query field

like

public static QueryField like(Mapping field)

Informs the compiler, that by default, equality checks are used for this field.

However, if there are wildcards in the filter value, an expanding constraint can be generated.

This ensures that a proper database index can be used for common queries.

Parameters:

field - the field to search in

Returns:

the generated query field

startsWith

public static QueryField startsWith(Mapping field)

Informs the compiler, that by default an expanding search like a prefix query may be generated for this field.

Depending on the underlying database an index might be used to support this query. If the database cannot execute prefix queries if may fallback to an equals constraint.

Parameters:

field - the field to search in

Returns:

the generated query field

contains

public static QueryField contains(Mapping field)

Informs the compiler, that by default a fully expanding search like a contains query may be generated for this field.

This will most probably disable any support for database indices and should only be used for reasonably sized datasets.

Parameters:

field - the field to search in

Returns:

the generated query field

getField

public Mapping getField()

getMode

public QueryField.Mode getMode()