net.sf.ehcache.store
Interface StoreQuery

public interface StoreQuery

An immutable query that a Store can execute

Author:

teck

Nested Class Summary

static interface

StoreQuery.Ordering An attribute / direction ordering pair

Method Summary

List<AggregatorInstance<?>>	getAggregatorInstances() Get the requested aggregators
Cache	getCache() Get the cache this query originated from
Criteria	getCriteria() Get the search criteria
List<StoreQuery.Ordering>	getOrdering() Get the requested search orderings
Set<Attribute<?>>	groupByAttributes() Get the set of attributes to group result set by
int	maxResults() Get the maximum number of results to return
Set<Attribute<?>>	requestedAttributes() Get the set of attributes requested by this query
boolean	requestsKeys() Are keys requested?
boolean	requestsValues() Are values requested?

Method Detail

getCriteria

Criteria getCriteria()

Get the search criteria

Returns:

the search criteria

requestsKeys

boolean requestsKeys()

Are keys requested?

Returns:

true if keys requested

requestsValues

boolean requestsValues()

Are values requested?

Returns:

true if values requested

getCache

Cache getCache()

Get the cache this query originated from

Returns:

cache

requestedAttributes

Set<Attribute<?>> requestedAttributes()

Get the set of attributes requested by this query

Returns:

the requested attributes (if any)

groupByAttributes

Set<Attribute<?>> groupByAttributes()

Get the set of attributes to group result set by

Returns:

attributes to group by (if any)

Since:

2.6

getOrdering

List<StoreQuery.Ordering> getOrdering()

Get the requested search orderings

Returns:

the request sort orders (if any)

maxResults

int maxResults()

Get the maximum number of results to return

Returns:

max results. A negative number means unlimited results

getAggregatorInstances

List<AggregatorInstance<?>> getAggregatorInstances()

Get the requested aggregators

Returns:

the include aggregators (if any)