sirius.db.mixing.query

Class Query<Q,E extends BaseEntity<?>,C extends Constraint>

java.lang.Object

sirius.db.mixing.query.BaseQuery<Q,E>

sirius.db.mixing.query.Query<Q,E,C>

Type Parameters:

Q - the effective type of the query

E - the type of entities being queried

C - the type of constraints accepted by this query

Direct Known Subclasses:

ElasticQuery, MongoQuery, SmartQuery

public abstract class Query<Q,E extends BaseEntity<?>,C extends Constraint>
extends BaseQuery<Q,E>

Describes the minimal functionality to be supported by a query generated by a mapper.

Field Summary

Fields inherited from class sirius.db.mixing.query.BaseQuery

descriptor, limit, MAX_LIST_SIZE, mixing, skip

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Query(EntityDescriptor descriptor)

Method Summary

Modifier and Type	Method and Description
abstract long	count() Executes the query and counts the number of results.
abstract void	delete() Deletes all matches using the BaseMapper.delete(BaseEntity) of the appropriate mapper.
Q	eq(Mapping field, Object value) Adds a constraint which ensures that the given field contains the given value.
Q	eqIgnoreNull(Mapping field, Object value) Adds a constraint which ensures that the given field contains the given value.
abstract boolean	exists() Determines if the query would have at least one matching entity.
abstract FilterFactory<C>	filters()
Q	ne(Mapping field, Object value) Adds a constraint which ensures that the given field does not contain the given value.
abstract Q	orderAsc(Mapping field) Adds a sort constraint to order by the given field ascending.
abstract Q	orderDesc(Mapping field) Adds a sort constraint to order by the given field descending.
Q	queryString(String query, QueryField... fields) Adds a query string filter to the given query.
abstract void	truncate() Deletes all matches using the capabilities of the underlying database.
abstract Q	where(C constraint) Applies the given contraints to the query.

Methods inherited from class sirius.db.mixing.query.BaseQuery

failOnOverflow, first, getDescriptor, getLimit, iterate, iterateAll, limit, one, queryFirst, queryList, queryOne, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

protected Query(EntityDescriptor descriptor)

Method Detail

where

public abstract Q where(C constraint)

Applies the given contraints to the query.

Parameters:

constraint - the constraint which has to be fullfilled

Returns:

the query itself for fluent method calls

filters

public abstract FilterFactory<C> filters()

eq

public Q eq(Mapping field,
            Object value)

Adds a constraint which ensures that the given field contains the given value.

Parameters:

field - the name of the field to filter on

value - the value to filter on

Returns:

the query itself for fluent method calls

ne

public Q ne(Mapping field,
            Object value)

Adds a constraint which ensures that the given field does not contain the given value.

Parameters:

field - the name of the field to filter on

value - the value to filter on

Returns:

the query itself for fluent method calls

eqIgnoreNull

public Q eqIgnoreNull(Mapping field,
                      Object value)

Adds a constraint which ensures that the given field contains the given value.

If the given value is null, the constraint is skipped.

Parameters:

field - the field to check

value - the value to filter on

Returns:

the query itself for fluent method calls

queryString

public Q queryString(String query,
                     QueryField... fields)

Adds a query string filter to the given query.

Parameters:

query - the query to search for

fields - the fields to search in

Returns:

the query itself for fluent method calls

See Also:

FilterFactory.queryString(EntityDescriptor, String, QueryField...)

orderAsc

public abstract Q orderAsc(Mapping field)

Adds a sort constraint to order by the given field ascending.

Parameters:

field - the field to order by.

Returns:

the builder itself for fluent method calls

orderDesc

public abstract Q orderDesc(Mapping field)

Adds a sort constraint to order by the given field descending.

Parameters:

field - the field to order by.

Returns:

the builder itself for fluent method calls

count

public abstract long count()

Executes the query and counts the number of results.

Returns:

the number of matched result entries

exists

public abstract boolean exists()

Determines if the query would have at least one matching entity.

Returns:

true if at least one entity matches the query, false otherwise.

delete

public abstract void delete()

Deletes all matches using the BaseMapper.delete(BaseEntity) of the appropriate mapper.

Be aware that this might be slow for very large result sets.

truncate

public abstract void truncate()

Deletes all matches using the capabilities of the underlying database.

Therefore no checks or anything will be invoked for the deleted entities.

Use this for larger result sets where integrity and constraints do not matter or are managed manually.