Implements net.sf.ehcache.search.Query.addCriteria.

Doc from net.sf.ehcache.search.Query.addCriteria.

Adds a criteria to the query

Implements net.sf.ehcache.search.Query.addGroupBy.

Doc from net.sf.ehcache.search.Query.addGroupBy.

Group result set by unique value(s) of specified attribute(s). Rows with duplicate values for these attributes will be removed. This method may also be chained to achieve the same effect.

Implements net.sf.ehcache.search.Query.addOrderBy.

Doc from net.sf.ehcache.search.Query.addOrderBy.

Request result set ordering by the given attribute and direction. This call can be made multiple times to specify second level. third level, etc orderings

Parameters

attribute:Attribute<?>

The attribute to order the results by

direction:Direction

Ascending or descending

Returns:Query

this

Implements net.sf.ehcache.search.Query.end.

Doc from net.sf.ehcache.search.Query.end.

Optional method for terminating query creation. If called the query becomes immutable, so that attempting any further mutations will result in an exception

Implements net.sf.ehcache.search.Query.execute.

Doc from net.sf.ehcache.search.Query.execute.

Execute this query. Every call to this method will re-execute the query and return a distinct results object.

An empty results object will be returned (on timeout) for non-stop enabled caches with net.sf.ehcache.config.TimeoutBehaviorConfiguration.TimeoutBehaviorType#NOOP and net.sf.ehcache.config.TimeoutBehaviorConfiguration.TimeoutBehaviorType#LOCAL_READS behavior

Returns:Results

query results

Implements net.sf.ehcache.search.Query.execute.

Doc from net.sf.ehcache.search.Query.execute.

Like execute(), but with specified execution parameters.

Implements net.sf.ehcache.store.StoreQuery.getAggregatorInstances.

Doc from net.sf.ehcache.store.StoreQuery.getAggregatorInstances.

Get the requested aggregator instances

Returns:List<AggregatorInstance<?>>

the include aggregator instances (if any)

Implements net.sf.ehcache.store.StoreQuery.getAggregators.

Doc from net.sf.ehcache.store.StoreQuery.getAggregators.

Get the requested aggregators

Returns:List<Aggregator>

the include aggregators (if any)

Implements net.sf.ehcache.store.StoreQuery.getCache.

Doc from net.sf.ehcache.store.StoreQuery.getCache.

Get the cache this query originated from

Returns:Cache

cache

Implements net.sf.ehcache.store.StoreQuery.getCriteria.

Doc from net.sf.ehcache.store.StoreQuery.getCriteria.

Get the search criteria

Returns:Criteria

the search criteria

Implements net.sf.ehcache.store.StoreQuery.getExecutionHints.

Doc from net.sf.ehcache.store.StoreQuery.getExecutionHints.

Get execution hints for this query

Returns:ExecutionHints

null if no hints were provided

Annotations

@Override

Implements net.sf.ehcache.store.StoreQuery.getOrdering.

Doc from net.sf.ehcache.store.StoreQuery.getOrdering.

Get the requested search orderings

Returns:List<StoreQuery.Ordering>

the request sort orders (if any)

Implements net.sf.ehcache.store.StoreQuery.getTargets.

Doc from net.sf.ehcache.store.StoreQuery.getTargets.

This needs to be cleaned up. We don't want to introduce any kind of ordering here, as there simply is none.

Meanwhile, this is used to keep the ordering on BMQL created Queries. Yet, QueryManagerBuilder, which creates the QueryManager, doesn't let us qualify the Query type further to add this "ordering" concept of "targets" to it.
And this "ordering" shouldn't become part of the QueryManager API neither as each implementation might require something different.

Returns:String[]

select target names, searchAttribute or aggregator

Implements net.sf.ehcache.store.StoreQuery.groupByAttributes.

Doc from net.sf.ehcache.store.StoreQuery.groupByAttributes.

Get the set of attributes to group result set by

Returns:Set<Attribute<?>>

attributes to group by (if any)

Implements net.sf.ehcache.search.Query.includeAggregator.

Doc from net.sf.ehcache.search.Query.includeAggregator.

Request this query to aggregate the results by the given Aggregator(s)

This method may be called multiple times to request multiple aggregations

Returns:Query

this

Implements net.sf.ehcache.search.Query.includeAttribute.

Doc from net.sf.ehcache.search.Query.includeAttribute.

Request that the given attribute(s) should be present in the result for this query. This call can be made multiple times to add to the set of selected attributes.

Note that in a distributed cache attributes may need to come over the network. To prevent very large network transfers, consider limiting the results size with maxResults(int) or by using Results#range rathern than Results#all()

Parameters

attributes:Attribute<?>[]

the query attributes to select

Returns:Query

this

Implements net.sf.ehcache.search.Query.includeKeys.

Doc from net.sf.ehcache.search.Query.includeKeys.

Request that the key object be present in the results.

Returns:Query

this

Implements net.sf.ehcache.search.Query.includeValues.

Doc from net.sf.ehcache.search.Query.includeValues.

Request that the value object be present in the results.

Returns:Query

this

Implements net.sf.ehcache.search.Query.maxResults.

Doc from net.sf.ehcache.search.Query.maxResults.

Restrict the number of results returned from the search.

By default an unlimited number of results can be returned. This could cause an OutOfMemoryError to be thrown. It is therefore recommended to add an maxResults clause to your query to limit the size.

Negative values are ignored and result in the default behaviour: unlimited number of results.

Parameters

maxResults:int

the maximum number of results to return

Returns:Query

this

Implements net.sf.ehcache.store.StoreQuery.maxResults.

Doc from net.sf.ehcache.store.StoreQuery.maxResults.

Get the maximum number of results to return

Returns:int

max results. A negative number means unlimited results

Implements net.sf.ehcache.store.StoreQuery.requestedAttributes.

Doc from net.sf.ehcache.store.StoreQuery.requestedAttributes.

Get the set of attributes requested by this query

Returns:Set<Attribute<?>>

the requested attributes (if any)

Implements net.sf.ehcache.store.StoreQuery.requestsKeys.

Doc from net.sf.ehcache.store.StoreQuery.requestsKeys.

Are keys requested?

Returns:boolean

true if keys requested

Implements net.sf.ehcache.store.StoreQuery.requestsValues.

Doc from net.sf.ehcache.store.StoreQuery.requestsValues.

Are values requested?

Returns:boolean

true if values requested

Implements net.sf.ehcache.store.StoreQuery.targets.

Doc from net.sf.ehcache.store.StoreQuery.targets.

Set the names of the select targets. These will either be searchAttribute names or aggregator display names, eg. 'ave(salary)' This is used by BMQL to form the return results.

Annotations

@Override