com.qcadoo.model.api.search

Interface SearchQueryBuilder

public interface SearchQueryBuilder

Object represents the query builder for finding entities.

The query is based on HQL - the Hibernate's query language. The only difference is the way to name the entities. You must use hash, plugin's name, underscore and model's name. For example "#plugin_model".

If You start the query from "where" keyword, the "from" section will be automatically taken from current dataDefinition object.

Parameters are binded to the query using placeholders - colon with parameter's name.

Please see more on the official reference.

Examples:

• where name = :name - select all entities from current data definition with given name, list of "products_product" entities will be returned
• from #products_product where name = :name - select all "products_product" entities with given name, list of "products_product" entities will be returned
• from #products_product as p where p.name = :name - select all "products_product" entities with given name, list of "products_product" entities will be returned
• from #products_product as p where p.vendor.name = :name - select all "products_product" entities with belongs to field "vendor" with given name, list of "products_product" entities will be returned
• from #products_product as p where size(p.components) > 0 - select all "products_product" entities which have components, list of "products_product" entities will be returned
• select p from #products_product as p where p.name = :name - select all "products_product" entities with given name, list of "products_product" entities will be returned
• select p, upper(p.name) from #products_product as p where p.name = :name - select all "products_product" entities with given name, list of dynamic entities will be returned, field "0" will contain "products_product" entity, field "1" will contain uppercased name
• select p as product, upper(p.name) as name from #products_product as p where p.name = :name - select all "products_product" entities with given name, list of dynamic entities will be returned, field "product" will contain "products_product" entity, field "name" will contain uppercased name
• from #products_product order by name asc- select all "products_product" ordered by name, list of "products_product" entities will be returned
• select distinct p.name as name from #products_product as p where lower(p.name) like 'a%' - select all unique names started with letter "a", list of dynamic entities will be returned, field "name" will contain name

Since:

0.4.1

Method Summary

Modifier and Type	Method and Description
void	addCacheable(org.hibernate.Query query) Add caching parameter to query
SearchResult	list() Finds entities using this criteria.
SearchQueryBuilder	setBigDecimal(String name, BigDecimal val) Sets the "bigDecimal" parameter for given placeholder.
SearchQueryBuilder	setBoolean(String name, boolean val) Sets the "boolean" parameter for given placeholder.
SearchQueryBuilder	setByte(String name, byte val) Sets the "byte" parameter for given placeholder.
SearchQueryBuilder	setCacheable(boolean cacheable) Enable caching of this query result, provided query caching is enabled for the underlying session factory.
SearchQueryBuilder	setDate(String name, Date val) Sets the "date" parameter for given placeholder.
SearchQueryBuilder	setDouble(String name, double val) Sets the "double" parameter for given placeholder.
SearchQueryBuilder	setEntity(String name, Entity entity) Sets the "entity" parameter for given placeholder.
SearchQueryBuilder	setEntity(String name, String pluginIdentifier, String modelName, long id) Sets the "entity" parameter for given placeholder.
SearchQueryBuilder	setFirstResult(int firstResult) Sets the first result, by default the first result is equal to zero.
SearchQueryBuilder	setFloat(String name, float val) Sets the "float" parameter for given placeholder.
SearchQueryBuilder	setInteger(String name, int val) Sets the "integer" parameter for given placeholder.
SearchQueryBuilder	setLong(String name, long val) Sets the "long" parameter for given placeholder.
SearchQueryBuilder	setMaxResults(int maxResults) Sets the max results, by default there is no limit.
SearchQueryBuilder	setParameter(String name, Object val) Sets the parameter for given placeholder.
SearchQueryBuilder	setParameterList(String name, Collection<? extends Object> parameters) Sets the collection of parameters for given placeholder.
SearchQueryBuilder	setShort(String name, short val) Sets the "short" parameter for given placeholder.
SearchQueryBuilder	setString(String name, String val) Sets the "string" parameter for given placeholder.
SearchQueryBuilder	setTime(String name, Date val) Sets the "time" parameter for given placeholder.
SearchQueryBuilder	setTimestamp(String name, Date date) Sets the "timestamp" parameter for given placeholder.
Entity	uniqueResult() Finds unique entity.

Method Detail

addCacheable

void addCacheable(org.hibernate.Query query)

Add caching parameter to query

Parameters:

query -

list

SearchResult list()

Finds entities using this criteria.

Returns:

search result

setBigDecimal

SearchQueryBuilder setBigDecimal(String name,
                                 BigDecimal val)

Sets the "bigDecimal" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setBoolean

SearchQueryBuilder setBoolean(String name,
                              boolean val)

Sets the "boolean" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setByte

SearchQueryBuilder setByte(String name,
                           byte val)

Sets the "byte" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setCacheable

SearchQueryBuilder setCacheable(boolean cacheable)

Enable caching of this query result, provided query caching is enabled for the underlying session factory.

Parameters:

cacheable -

Returns:

this search builder

setDate

SearchQueryBuilder setDate(String name,
                           Date val)

Sets the "date" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setDouble

SearchQueryBuilder setDouble(String name,
                             double val)

Sets the "double" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setEntity

SearchQueryBuilder setEntity(String name,
                             Entity entity)

Sets the "entity" parameter for given placeholder.

Parameters:

name - placeholder

entity - value of the parameter

Returns:

this query builder

setEntity

SearchQueryBuilder setEntity(String name,
                             String pluginIdentifier,
                             String modelName,
                             long id)

Sets the "entity" parameter for given placeholder.

Parameters:

name - placeholder

id - entity's id

modelName - entity's model

pluginIdentifier - entity's plugin

Returns:

this query builder

setFirstResult

SearchQueryBuilder setFirstResult(int firstResult)

Sets the first result, by default the first result is equal to zero.

Parameters:

firstResult - first result

Returns:

this query builder

setFloat

SearchQueryBuilder setFloat(String name,
                            float val)

Sets the "float" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setInteger

SearchQueryBuilder setInteger(String name,
                              int val)

Sets the "integer" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setLong

SearchQueryBuilder setLong(String name,
                           long val)

Sets the "long" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setMaxResults

SearchQueryBuilder setMaxResults(int maxResults)

Sets the max results, by default there is no limit.

Parameters:

maxResults - max results

Returns:

this query builder

setParameter

SearchQueryBuilder setParameter(String name,
                                Object val)

Sets the parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setParameterList

SearchQueryBuilder setParameterList(String name,
                                    Collection<? extends Object> parameters)

Sets the collection of parameters for given placeholder.

Parameters:

name - placeholder

val - collection of values for the parameter

Returns:

this query builder

setShort

SearchQueryBuilder setShort(String name,
                            short val)

Sets the "short" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setString

SearchQueryBuilder setString(String name,
                             String val)

Sets the "string" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setTime

SearchQueryBuilder setTime(String name,
                           Date val)

Sets the "time" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

setTimestamp

SearchQueryBuilder setTimestamp(String name,
                                Date date)

Sets the "timestamp" parameter for given placeholder.

Parameters:

name - placeholder

val - value of the parameter

Returns:

this query builder

uniqueResult

Entity uniqueResult()

Finds unique entity.

Returns:

entity