com.tridion.broker.querying

Class Query

java.lang.Object

com.tridion.broker.querying.Query

Direct Known Subclasses:

SubQuery

public class Query
extends Object

This class makes it possible to query the BrokerStorage for the items that are stored. To make this possible the Query applies a set of Query Criteria which will be used to retrieve the desired Items from the storage. The Criteria can be a set of Criteria or a single Criteria. The Criteria can be manually constructor or the CriteriaBuilder can be used.

Constructor Summary

Constructors

Constructor and Description
Query() This constructs a Query object, enabling the Query facilities.
Query(Criteria criteria) This constructs a Query object, enabling the Query facilities.

Method Summary

Modifier and Type	Method and Description
void	addLimitFilter(LimitFilter filter) Deprecated. Use setResultFilter instead.
void	addSorting(SortParameter sortParameter) Apply sorting parameter to query.
com.tridion.meta.Item[]	executeEntityQuery() Execute the Broker query.
String[]	executeQuery() Execute the Broker query.
Criteria	getCriteria() Retrieves the Criteria applied to this Query.
protected QueryResult	getQueryResult(String... properties) Executes the actual query.
protected QueryService	getQueryService()
void	setCriteria(Criteria theQueryCriteria) Sets the Criteria to apply to the Query, the CriteriaBuilder can be used to build a set of Criteria.
void	setResultFilter(ResultFilter filter) Sets the result filter to the Query.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query()

This constructs a Query object, enabling the Query facilities.

Query

public Query(Criteria criteria)

This constructs a Query object, enabling the Query facilities.

Parameters:

criteria - Criteria for the query

Method Detail

getQueryService

protected QueryService getQueryService()

addLimitFilter

@Deprecated
public void addLimitFilter(LimitFilter filter)

Deprecated. Use setResultFilter instead.

Add filter to query. More than one filter could be added.

Parameters:

filter - Filter that will be added to the query

setResultFilter

public void setResultFilter(ResultFilter filter)

Sets the result filter to the Query.

Parameters:

filter - The resultFilter to apply to the query.

addSorting

public void addSorting(SortParameter sortParameter)

Apply sorting parameter to query.

Parameters:

sortParameter - Sorting that will be applied.

setCriteria

public void setCriteria(Criteria theQueryCriteria)

Sets the Criteria to apply to the Query, the CriteriaBuilder can be used to build a set of Criteria.

Parameters:

theQueryCriteria - The criteria to apply to the Query

getCriteria

public Criteria getCriteria()

Retrieves the Criteria applied to this Query.

Returns:

The Criteria of this Query, or null if no criteria are set

executeQuery

public String[] executeQuery()
                      throws StorageException

Execute the Broker query. Can return null in case of invalid query as well as empty array otherwise.

Returns:

An array of Strings containing the found items

Throws:

StorageException - If unable to execute the Query

executeEntityQuery

public com.tridion.meta.Item[] executeEntityQuery()
                                           throws StorageException

Execute the Broker query.

Returns:

An array of Model Entities containing the found items

Throws:

StorageException - If unable to execute the Query

getQueryResult

protected QueryResult getQueryResult(String... properties)
                              throws StorageException

Executes the actual query.

Returns:

The QueryResult object containing internal model.

Throws:

StorageException - If unable to execute the Query