Package ch.tocco.nice2.persist.core.api.hibernate.query.builder

Interface QueryBuilderFactory

All Known Implementing Classes:

QueryBuilderFactoryImpl

public interface QueryBuilderFactory

Factory class for hibernate query builders

Method Summary

Modifier and Type	Method	Description
Predicate<Entity>	asPredicate(Condition condition)	Get a Predicate for the provided Condition.
CountQueryBuilder	count(Class<? extends Entity> entityClass)	Create a new CountQueryBuilder which executes count queries.
CountQueryBuilder	count(Class<? extends Entity> entityClass, Map<String,?> hints)	Create a new CountQueryBuilder which executes count queries.
CountQueryBuilder	count(String modelName)	Create a new CountQueryBuilder which executes count queries.
CountQueryBuilder	count(String modelName, Map<String,?> hints)	Create a new CountQueryBuilder which executes count queries.
default boolean	evaluate(Condition condition, Entity target)	Same as evaluate(Condition, Entity, Map) forwarding an empty parameter map for convenience.
boolean	evaluate(Condition condition, Entity target, Map<String,Object> params)	Evaluates the given `condition` against the given entity.
EntityQueryBuilder<Entity>	find(String entityModel)	Create an EntityQueryBuilder with the provided entity model as root
PrimaryKeyQueryBuilder	findKeys(String entityModel)
EntityQueryBuilder<Entity>	resolve(EntityReference source, Path relationPath)
EntityQueryBuilder<Entity>	resolve(EntityReference source, String relationPath)	Create an EntityQueryBuilder that first resolves the given relation path and uses the target entity model of the given relation path as query root.
PrimaryKeyQueryBuilder	resolveKeys(EntityReference source, Path relationPath)
PrimaryKeyQueryBuilder	resolveKeys(EntityReference source, String relationPath)	Create an PrimaryKeyQueryBuilder that first resolves the given relation path and uses the target entity model of the given relation path as query root.
<E> SinglePathQueryBuilder<E>	select(Class<E> type, String entityModel, String column)	Create a SinglePathQueryBuilder with the provided entity model as root and the single column as selection
<T> PathQueryBuilder<T>	select(Class<T> returnType, String entityModel, String... columns)	Create a PathQueryBuilder with the provided entity model as root and the provided columns as selection
default PathQueryBuilder<Map>	select(String entityModel, String... columns)	overload of select(Class, String, String...) that uses a Map as return type

Method Details

find

EntityQueryBuilder<Entity> find(String entityModel)

Create an EntityQueryBuilder with the provided entity model as root

Parameters:

entityModel - the target entity model

Returns:

the created EntityQueryBuilder

findKeys

PrimaryKeyQueryBuilder findKeys(String entityModel)

select

<T> PathQueryBuilder<T> select(Class<T> returnType,
 String entityModel,
 String... columns)

Create a PathQueryBuilder with the provided entity model as root and the provided columns as selection

Parameters:

returnType - the type the query returns, currently either Map or Object[]

entityModel - the target entity model

columns - the columns to select

Returns:

the created PathQueryBuilder

select

default PathQueryBuilder<Map> select(String entityModel,
 String... columns)

overload of select(Class, String, String...) that uses a Map as return type

select

<E> SinglePathQueryBuilder<E> select(Class<E> type,
 String entityModel,
 String column)

Create a SinglePathQueryBuilder with the provided entity model as root and the single column as selection

Type Parameters:

E - the return type, equal to the type of the selected column

Parameters:

type - the type of the selected column

entityModel - the target entity model

column - the selected column

Returns:

the created SinglePathQueryBuilder

resolve

EntityQueryBuilder<Entity> resolve(EntityReference source,
 String relationPath)

Create an EntityQueryBuilder that first resolves the given relation path and uses the target entity model of the given relation path as query root.

Parameters:

source - the source entity

relationPath - the relation path, e.g. 'relAddress_user.relAddress'

Returns:

the created EntityQueryBuilder

resolve

EntityQueryBuilder<Entity> resolve(EntityReference source,
 Path relationPath)

resolveKeys

PrimaryKeyQueryBuilder resolveKeys(EntityReference source,
 String relationPath)

Create an PrimaryKeyQueryBuilder that first resolves the given relation path and uses the target entity model of the given relation path as query root.

Parameters:

source - the source entity

relationPath - the relation path, e.g. 'relAddress_user.relAddress'

Returns:

the created PrimaryKeyQueryBuilder

resolveKeys

PrimaryKeyQueryBuilder resolveKeys(EntityReference source,
 Path relationPath)

count

CountQueryBuilder count(Class<? extends Entity> entityClass)

Create a new CountQueryBuilder which executes count queries.

Parameters:

entityClass - the root entity

count

CountQueryBuilder count(String modelName)

Create a new CountQueryBuilder which executes count queries.

Parameters:

modelName - the model name of the root entity

count

CountQueryBuilder count(Class<? extends Entity> entityClass,
 Map<String,?> hints)

Create a new CountQueryBuilder which executes count queries.

Parameters:

entityClass - the root entity

hints - optional hints about the query (see QueryHints for available hints)

count

CountQueryBuilder count(String modelName,
 Map<String,?> hints)

Create a new CountQueryBuilder which executes count queries.

Parameters:

modelName - the model name of the root entity

hints - optional hints about the query (see QueryHints for available hints)

evaluate

boolean evaluate(Condition condition,
 Entity target,
 Map<String,Object> params)

Evaluates the given `condition` against the given entity. Returns `true` if the entity would have been returned from a query formed by `condition`, `false` otherwise. The `params` map must contain all parameter values if those are used within the `condition`. Note that subqueries (like `EXISTS` and `COUNT`) and functions (like `fulltext` or `DISTANCE`) are currently *not* supported. `JdbcFunction`s (like `DISTANCE`) can't work anyways as they are directly translated to database calls.

evaluate

default boolean evaluate(Condition condition,
 Entity target)

Same as evaluate(Condition, Entity, Map) forwarding an empty parameter map for convenience.

asPredicate

Predicate<Entity> asPredicate(Condition condition)

Get a Predicate for the provided Condition. It can be used, for example to filter a list of previously loaded Entitys.

Parameters:

condition - a Condition