Package | Description |
---|---|
net.sf.ehcache |
This package contains the public API for using ehcache.
|
net.sf.ehcache.search |
This package contains classes for ehcache core search API.
|
net.sf.ehcache.search.aggregator |
This package contains classes for search aggregator functionality.
|
net.sf.ehcache.search.attribute |
This package contains classes for ehcache search attributes
|
net.sf.ehcache.search.expression |
This package contains classes for search expression types
(ie.
|
net.sf.ehcache.search.impl |
This package contains an implementation for Results.
|
net.sf.ehcache.store |
Store package.
|
net.sf.ehcache.transaction |
This package contains classes for controlling cache operations for transactional use.
|
Modifier and Type | Method and Description |
---|---|
Results |
CacheQuery.execute()
Execute this query.
|
(package private) Results |
Cache.executeQuery(StoreQuery query)
Execute the given query
|
Query |
CacheQuery.includeAggregator(Aggregator... aggregators)
Request this query to aggregate the results by the given Aggregator(s)
This method may be called multiple times to request multiple aggregations
|
private void |
Cache.validateSearchQuery(StoreQuery query) |
Modifier and Type | Method and Description |
---|---|
java.util.List<Result> |
Results.all()
Retrieve all of the cache results in one shot.
|
java.util.List<Result> |
NullResults.all()
Retrieve all of the cache results in one shot.
|
Results |
Query.execute()
Execute this query.
|
java.util.List<java.lang.Object> |
Result.getAggregatorResults()
Retrieve the aggregator value(s)
|
<T> T |
Result.getAttribute(Attribute<T> attribute)
Retrieve the given attribute value for this cache entry
|
java.lang.Object |
Result.getKey()
Return the key for this cache entry.
|
java.lang.Object |
Result.getValue()
Return the value for this cache entry.
|
Query |
Query.includeAggregator(Aggregator... aggregators)
Request this query to aggregate the results by the given Aggregator(s)
This method may be called multiple times to request multiple aggregations
|
java.util.List<Result> |
Results.range(int start,
int count)
Retrieve a subset of the cache results.
|
java.util.List<Result> |
NullResults.range(int start,
int count)
Retrieve a subset of the cache results.
|
Modifier and Type | Class and Description |
---|---|
class |
AggregatorException
Thrown if an Aggregator cannot complete.
|
Modifier and Type | Class and Description |
---|---|
class |
AttributeExtractorException
An exception to indicate that an attribute extractor was unable to be processed.
|
Modifier and Type | Method and Description |
---|---|
static AttributeType |
AttributeType.typeFor(java.lang.String name,
java.lang.Object value)
Get the appropriate @{link
AttributeType enum for the given object value. |
abstract void |
AttributeType.validateValue(java.lang.String name,
java.lang.Object value)
Validate that the given value is in fact of the correct type
|
Modifier and Type | Method and Description |
---|---|
static AttributeExtractor |
BaseCriteria.getExtractor(java.lang.String attrName,
java.util.Map<java.lang.String,AttributeExtractor> knownExtractors)
For given attribute name, return its corresponding extractors from supplied map, if it exists.
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Result> |
ResultsImpl.all()
Retrieve all of the cache results in one shot.
|
java.util.List<java.lang.Object> |
BaseResult.getAggregatorResults()
Retrieve the aggregator value(s)
|
static java.util.Map<java.lang.String,? extends java.lang.Object> |
DynamicSearchChecker.getSearchAttributes(Element e,
java.util.Set<java.lang.String> reservedAttrs,
DynamicAttributesExtractor extractor)
Extracts dynamically indexed search attributes from cache element using provided extractor,
validating against reserved set of attribute names (provided by Ehcache search config)
|
java.lang.Object |
BaseResult.getValue()
Return the value for this cache entry.
|
java.util.List<Result> |
ResultsImpl.range(int start,
int length)
Retrieve a subset of the cache results.
|
Modifier and Type | Method and Description |
---|---|
Results |
ElementIdAssigningStore.executeQuery(StoreQuery query)
Execute the given query on this store
|
Results |
Store.executeQuery(StoreQuery query)
Execute the given query on this store
|
Modifier and Type | Method and Description |
---|---|
java.util.List<Result> |
AbstractTransactionStore.TxSearchResults.all() |
java.util.List<java.lang.Object> |
AbstractTransactionStore.TxResult.getAggregatorResults() |
<T> T |
AbstractTransactionStore.TxResult.getAttribute(Attribute<T> attribute) |
java.lang.Object |
AbstractTransactionStore.TxResult.getKey() |
java.lang.Object |
AbstractTransactionStore.TxResult.getValue() |
java.util.List<Result> |
AbstractTransactionStore.TxSearchResults.range(int start,
int count) |