ehcache-core 2.10.9.2 · net.sf.ehcache.search.Results

Method Summary

Modifier and Type	Method and Description
public List<Result>	Returns: a List of all the matching cache entries all() List containing all of the search results.
public void	discard() Discard this query result.
public boolean	Returns: true if this is an aggregate hasAggregators() Whether the results contains aggregates
public boolean	Returns: true if attributes are included hasAttributes() Whether the Results have cache attributes included.
public boolean	Returns: true if keys are included hasKeys() Whether the Results have cache keys included.
public boolean	Returns: true if values are included hasValues() Whether the Results have cache values included.
public List<Result>	Returns: a List of the given size. This list will be smaller than the requested size if no more results are available. If there are no more results an empty list will be returned. range(int starting index to access start, int the number of results to return count) Retrieve a subset of the cache results.
public int	Returns: number of results present size() Results size

Method Detail

all	back to summary
public List<Result> all() throws SearchException List containing all of the search results. Returns:List<Result> a List of all the matching cache entries

all

back to summary

public List<Result> all() throws SearchException

List containing all of the search results.

Returns:List<Result>: a List of all the matching cache entries

discard back to summary

discard	back to summary
public void discard() Discard this query result. This call is not mandatory but is recommended after the caller is done with results. It can allow the cache, which may be distributed, to immediately free any resources associated with this result. Multiple calls are ignored. Attempting to read results from this instance after this method has been called will produce `SearchException`

public void discard()

Discard this query result. This call is not mandatory but is recommended after the caller is done with results. It can allow the cache, which may be distributed, to immediately free any resources associated with this result.

Multiple calls are ignored. Attempting to read results from this instance after this method has been called will produce SearchException

hasAggregators	back to summary
public boolean hasAggregators() Whether the results contains aggregates Returns:boolean true if this is an aggregate

hasAggregators

back to summary

public boolean hasAggregators()

Whether the results contains aggregates

Returns:boolean: true if this is an aggregate

hasAttributes	back to summary
public boolean hasAttributes() Whether the Results have cache attributes included. If so these can be extracted from the Result object. Returns:boolean true if attributes are included

hasAttributes

back to summary

public boolean hasAttributes()

Whether the Results have cache attributes included. If so these can be extracted from the Result object.

Returns:boolean: true if attributes are included

hasKeys	back to summary
public boolean hasKeys() Whether the Results have cache keys included. If so these can be extracted from the Result object. Returns:boolean true if keys are included

hasKeys

back to summary

public boolean hasKeys()

Whether the Results have cache keys included. If so these can be extracted from the Result object.

Returns:boolean: true if keys are included

hasValues	back to summary
public boolean hasValues() Whether the Results have cache values included. If so these can be extracted from the Result object. Returns:boolean true if values are included

hasValues

back to summary

public boolean hasValues()

Whether the Results have cache values included. If so these can be extracted from the Result object.

Returns:boolean: true if values are included

range	back to summary
public List<Result> range(int start, int count) throws SearchException, IndexOutOfBoundsException Retrieve a subset of the cache results. This method is useful when showing "paged" results in a user interface. Parameters start:int starting index to access count:int the number of results to return Returns:List<Result> a List of the given size. This list will be smaller than the requested size if no more results are available. If there are no more results an empty list will be returned.

range

back to summary

public List<Result> range(int start, int count) throws SearchException, IndexOutOfBoundsException

Retrieve a subset of the cache results. This method is useful when showing "paged" results in a user interface.

Parameters

start:int: starting index to access
count:int: the number of results to return

Returns:List<Result>

a List of the given size. This list will be smaller than the requested size if no more results are available. If there are no more results an empty list will be returned.

size	back to summary
public int size() Results size Returns:int number of results present

size

back to summary

public int size()

Results size

Returns:int: number of results present

public Interface Results

Method Summary

Method Detail