com.qcadoo.model.api.search

Interface SearchCriteriaBuilder

public interface SearchCriteriaBuilder

Object represents the criteria builder for finding entities.

The criteria is based on the Hibernate's criteria. Please see more on the official reference.

Examples:

• dataDefinition.find().list() - select all entities from current data definition
• dataDefinition.find().setMaxResults(1).uniqueResult() - select first entity from current data definition
• dataDefinition.find().add(SerchResrictions.eq("name", "xxx")).list() - select all entities from current with given name
• dataDefinition.find().createAlias("vendor", "vendor").add(SerchResrictions.eq("vendor.name", "xxx").list() - select all entities with given vendor.name
• dataDefinition.find().add(SerchResrictions.isNotEmpty("components").list() - select all entities which have components
• dataDefinition.find().createAlias("vendor", "vendor").setProjections(SearchProjections.list().add(SearchProjections.id()).add(SearchProjections.field("vendor.name"))).list () - select all entities return its id and vendor's name
• dataDefinition.find().addOrder(SearchOrders.asc("name").list() - select all entities ordered ascending by name
• dataDefinition.find().setProjection(SearchProjections.distinct(SearchProjections.field("name"))).list() - select unique entities' names
• dataDefinition.find().add(SerchResrictions.or(SerchResrictions.eq("name", "xxx"), SerchResrictions.eq("name", "yyy"))).list() - select all entities from current with one of the given names

Method Summary

Modifier and Type	Method and Description
SearchCriteriaBuilder	add(SearchCriterion criterion) Adds restriction to the criteria.
SearchCriteriaBuilder	addOrder(SearchOrder order) Adds order to the criteria.
SearchCriteriaBuilder	createAlias(String association, String alias, JoinType joinType) Create alias for the association to the criteria using the specified join-type.
SearchCriteriaBuilder	createCriteria(String association, String alias) Create a new SearchCriteriaBuilder, "rooted" at the associated entity, assigning the given alias and using the inner join.
SearchCriteriaBuilder	createCriteria(String association, String alias, JoinType joinType) Create a new SearchCriteriaBuilder, "rooted" at the associated entity, assigning the given alias and using the specified join-type.
boolean	existsAliasForAssociation(String association)
String	getAliasForAssociation(String association)
SearchResult	list() Finds entities using this criteria.
SearchCriteriaBuilder	setCacheable(boolean cacheable) Enable caching of this query result, provided query caching is enabled for the underlying session factory.
SearchCriteriaBuilder	setFirstResult(int firstResult) Sets the first result, by default the first result is equal to zero.
SearchCriteriaBuilder	setMaxResults(int maxResults) Sets the max results, by default there is no limit.
SearchCriteriaBuilder	setProjection(SearchProjection projection) Adds projection to the criteria.
Entity	uniqueResult() Finds unique entity.

Method Detail

add

SearchCriteriaBuilder add(SearchCriterion criterion)

Adds restriction to the criteria.

Parameters:

criterion - criterion

Returns:

this search builder

Since:

0.4.1

addOrder

SearchCriteriaBuilder addOrder(SearchOrder order)

Adds order to the criteria.

Parameters:

order - order

Returns:

this search builder

Since:

0.4.1

createAlias

SearchCriteriaBuilder createAlias(String association,
                                  String alias,
                                  JoinType joinType)

Create alias for the association to the criteria using the specified join-type.

Parameters:

association - association

alias - alias

joinType - the type of join to use. If given joinType is not specified then JoinType.INNER will be used.

Returns:

this search builder

Since:

1.2.1

createCriteria

SearchCriteriaBuilder createCriteria(String association,
                                     String alias)

Create a new SearchCriteriaBuilder, "rooted" at the associated entity, assigning the given alias and using the inner join.

Parameters:

association - association

alias - alias

Returns:

search builder for the subcriteria

Since:

0.4.1

createCriteria

SearchCriteriaBuilder createCriteria(String association,
                                     String alias,
                                     JoinType joinType)

Create a new SearchCriteriaBuilder, "rooted" at the associated entity, assigning the given alias and using the specified join-type.

Parameters:

association - association

alias - alias

joinType - the type of join to use. If given joinType is not specified then JoinType.INNER will be used.

Returns:

search builder for the subcriteria

Since:

1.2.1

existsAliasForAssociation

boolean existsAliasForAssociation(String association)

getAliasForAssociation

String getAliasForAssociation(String association)

list

SearchResult list()

Finds entities using this criteria.

Returns:

search result

setCacheable

SearchCriteriaBuilder 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

setFirstResult

SearchCriteriaBuilder setFirstResult(int firstResult)

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

Parameters:

firstResult - first result

Returns:

this search builder

setMaxResults

SearchCriteriaBuilder setMaxResults(int maxResults)

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

Parameters:

maxResults - max results

Returns:

this search builder

setProjection

SearchCriteriaBuilder setProjection(SearchProjection projection)

Adds projection to the criteria.

Parameters:

projection - projection

Returns:

this search builder

Since:

0.4.1

uniqueResult

Entity uniqueResult()

Finds unique entity.

Returns:

entity