com.tridion.broker.querying.generators.service

Class CachingQueryService

java.lang.Object

com.tridion.broker.querying.generators.service.CachingQueryService

All Implemented Interfaces:

QueryService

public class CachingQueryService
extends Object
implements QueryService

This is the caching query mechanism used to add caching to query results. The query results are flushed as soon as any item metadata is stored that this query could return as a result

Constructor Summary

Constructors

Constructor and Description
CachingQueryService(QueryService wrappedService) Construct the CachingQueryDAO with a wrapped QueryDAO.

Method Summary

Modifier and Type	Method and Description
QueryResult	executeQuery(QueryConstructor queryConstructor, ResultFilter resultFilter) This executes the actual broker query based on the constructed query and resultFilter.
QueryResult	executeQuery(String selectField, Criteria criteria, Sorting sorting, ResultFilter resultFilter) This executes the actual broker query based on the given criteria, sorting and filter.
QueryConstructor	generateQuery(String selectField, Criteria criteria, Sorting sorting) This generates the main broker query needed to execute the JPQL query.
String	getStorageId() Returns the storageId that the queryService will query.

Methods inherited from class java.lang.Object

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

Constructor Detail

CachingQueryService

public CachingQueryService(QueryService wrappedService)

Construct the CachingQueryDAO with a wrapped QueryDAO.

Parameters:

wrappedService - The DAO of type QueryDAO

Method Detail

getStorageId

public String getStorageId()

Description copied from interface: QueryService

Returns the storageId that the queryService will query.

Specified by:

getStorageId in interface QueryService

Returns:

The storageId

executeQuery

public QueryResult executeQuery(String selectField,
                                Criteria criteria,
                                Sorting sorting,
                                ResultFilter resultFilter)
                         throws StorageException

Description copied from interface: QueryService

This executes the actual broker query based on the given criteria, sorting and filter. The query will be generated and executed.

Specified by:

executeQuery in interface QueryService

Parameters:

selectField - The default query field to select

criteria - The criteria to use for the broker query

sorting - The sort conditions to apply

resultFilter - The filter to apply to the end results

Returns:

The QueryResult, containing the item hits and found entities

Throws:

StorageException - If unable to execute the broker query

executeQuery

public QueryResult executeQuery(QueryConstructor queryConstructor,
                                ResultFilter resultFilter)
                         throws StorageException

Description copied from interface: QueryService

This executes the actual broker query based on the constructed query and resultFilter.

Specified by:

executeQuery in interface QueryService

Parameters:

queryConstructor - The constructed Query

resultFilter - The filter to apply to the end results

Returns:

The QueryResult, containing the item hits and found entities

Throws:

StorageException - If unable to execute the broker query

generateQuery

public QueryConstructor generateQuery(String selectField,
                                      Criteria criteria,
                                      Sorting sorting)
                               throws StorageException

Description copied from interface: QueryService

This generates the main broker query needed to execute the JPQL query. It generates the main query based on the selected field, criteria and sorting.

Specified by:

generateQuery in interface QueryService

Parameters:

selectField - The selected field

criteria - The criteria to use for the broker query

sorting - The sorting to apply to the query results

Returns:

The constructed broker query

Throws:

StorageException - If unable to generate a broker query