com.tangosol.coherence.rest

Class NamedQueryResource

java.lang.Object

com.tangosol.coherence.rest.NamedQueryResource

public class NamedQueryResource
extends Object

REST resource representing a set of filtered cache entries.

Author:

ic 2011.12.03

Field Summary

Fields

Modifier and Type	Field and Description
protected AggregatorRegistry	m_aggregatorRegistry Aggregator registry that is used to map the given aggregator name to an EntryAggregator instance.
protected NamedCache	m_cache NamedCache wrapped by this resource.
protected int	m_cMaxResults Maximum size of the result set this resource is allowed to return.
protected ProcessorRegistry	m_processorRegistry a processor registry that is used to map the given processor name to an EntryProcessor instance.
protected NamedQuery	m_query Named query responsible to filter cache entries.
protected QueryEngineRegistry	m_registry Query engine registry.

Constructor Summary

Constructors

Constructor and Description
NamedQueryResource(NamedCache cache, NamedQuery query, QueryEngineRegistry registry, int cMaxResults, AggregatorRegistry aggregatorRegistry, ProcessorRegistry processorRegistry) Create a instance of NamedQueryResource.

Method Summary

Modifier and Type	Method and Description
com.tangosol.coherence.rest.events.MapEventOutput	addListener(boolean fLite, javax.ws.rs.core.UriInfo uriInfo) Register SSE event listener for this named query.
javax.ws.rs.core.Response	aggregate(javax.ws.rs.core.UriInfo uriInfo, String sAggr) Perform an aggregating operation against the entries that belong to the named query.
protected Collection	executeQuery(javax.ws.rs.core.UriInfo uriInfo, ValueExtractor<Map.Entry,?> extractor, int nStart, int cResults, String sSort) Returns a collection of extracted values for cache entries that satisfy the criteria expressed by the query.
javax.ws.rs.core.Response	getEntries(javax.ws.rs.core.UriInfo uriInfo, int nStart, int cResults, String sSort, PropertySet propertySet) Return the cache entries that satisfy criteria defined by this resource.
javax.ws.rs.core.Response	getKeys(javax.ws.rs.core.UriInfo uriInfo) Return the keys for cache entries that satisfy criteria defined by this resource.
javax.ws.rs.core.Response	getValues(javax.ws.rs.core.UriInfo uriInfo, int nStart, int cResults, String sSort, PropertySet propertySet) Return the cache values that satisfy criteria defined by this resource.
protected Set	keys(javax.ws.rs.core.UriInfo uriInfo) Return the keys of cache entries that satisfy the named query criteria.
javax.ws.rs.core.Response	process(javax.ws.rs.core.UriInfo uriInfo, String sProc) Invoke the specified processor against the entries that belong to the named query.

Methods inherited from class java.lang.Object

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

Field Detail

m_cache

protected final NamedCache m_cache

NamedCache wrapped by this resource.

m_query

protected final NamedQuery m_query

Named query responsible to filter cache entries.

m_registry

protected final QueryEngineRegistry m_registry

Query engine registry.

m_cMaxResults

protected final int m_cMaxResults

Maximum size of the result set this resource is allowed to return.

m_aggregatorRegistry

protected final AggregatorRegistry m_aggregatorRegistry

Aggregator registry that is used to map the given aggregator name to an EntryAggregator instance.

m_processorRegistry

protected final ProcessorRegistry m_processorRegistry

a processor registry that is used to map the given processor name to an EntryProcessor instance.

Constructor Detail

NamedQueryResource

public NamedQueryResource(NamedCache cache,
                          NamedQuery query,
                          QueryEngineRegistry registry,
                          int cMaxResults,
                          AggregatorRegistry aggregatorRegistry,
                          ProcessorRegistry processorRegistry)

Create a instance of NamedQueryResource.

Parameters:

cache - cache to create a resource for

query - query filtering the cache entries

registry - query engine registry, contains mappings between query engines name and QueryEngine instance

cMaxResults - max size of result set for this resource

aggregatorRegistry - aggregator registry that is used to map the given aggregator name to an EntryAggregator instance

processorRegistry - processor registry that is used to map the given processor name to an the EntryProcessor instance

Method Detail

aggregate

@GET
 @Path(value="{aggr: \\s*(\\w(?:\\w|-)*)\\((.*)\\)}")
 @Produces(value={"application/json","application/xml","text/plain"})
public javax.ws.rs.core.Response aggregate(@Context
                                                                                                                                                                               javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                                                               @PathParam(value="aggr")
                                                                                                                                                                               String sAggr)

Perform an aggregating operation against the entries that belong to the named query.

Parameters:

uriInfo - UriInfo for the invoked resource method

sAggr - name of the aggregator

Returns:

the result of the aggregation

process

@POST
 @Path(value="{proc: \\s*(\\w(?:\\w|-)*)\\((.*)\\)}")
 @Produces(value={"application/json","application/xml"})
public javax.ws.rs.core.Response process(@Context
                                                                                                                                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                                                 @PathParam(value="proc")
                                                                                                                                                                 String sProc)

Invoke the specified processor against the entries that belong to the named query.

Parameters:

uriInfo - UriInfo for the invoked resource method

sProc - the name of the processor

Returns:

a Map containing the results of invoking the EntryProcessor against the entries that are selected by the given query

getValues

@GET
public javax.ws.rs.core.Response getValues(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 @MatrixParam(value="start") @DefaultValue(value="0")
                                                 int nStart,
                                                 @MatrixParam(value="count") @DefaultValue(value="-1")
                                                 int cResults,
                                                 @MatrixParam(value="sort")
                                                 String sSort,
                                                 @MatrixParam(value="p")
                                                 PropertySet propertySet)

Return the cache values that satisfy criteria defined by this resource.

Parameters:

uriInfo - UriInfo for the invoked resource method

nStart - the starting index of result set to be returned

cResults - the size of result set to be returned (page size)

sSort - a string expression that represents ordering

propertySet - properties to return (if null, values will be returned)

Returns:

values that satisfy criteria defined by this resource

getEntries

@GET
 @Path(value="entries")
 @Produces(value={"application/json","application/xml","text/plain"})
public javax.ws.rs.core.Response getEntries(@Context
                                                                                                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                                  @MatrixParam(value="start") @DefaultValue(value="0")
                                                                                                                                                  int nStart,
                                                                                                                                                  @MatrixParam(value="count") @DefaultValue(value="-1")
                                                                                                                                                  int cResults,
                                                                                                                                                  @MatrixParam(value="sort")
                                                                                                                                                  String sSort,
                                                                                                                                                  @MatrixParam(value="p")
                                                                                                                                                  PropertySet propertySet)

Return the cache entries that satisfy criteria defined by this resource.

Parameters:

uriInfo - UriInfo for the invoked resource method

nStart - the starting index of result set to be returned

cResults - the size of result set to be returned (page size)

sSort - a string expression that represents ordering

propertySet - the subset of properties to return for each value (if null, the complete values will be returned)

Returns:

the cache entries satisfying criteria defined by this resource

getKeys

@GET
 @Path(value="keys")
 @Produces(value={"application/json","application/xml","text/plain"})
public javax.ws.rs.core.Response getKeys(@Context
                                                                                                                                            javax.ws.rs.core.UriInfo uriInfo)

Return the keys for cache entries that satisfy criteria defined by this resource.

Parameters:

uriInfo - UriInfo for the invoked resource method

Returns:

the keys of the cache entries satisfying criteria defined by this resource

addListener

@GET
 @Produces(value="text/event-stream")
public com.tangosol.coherence.rest.events.MapEventOutput addListener(@MatrixParam(value="lite")
                                                                                                                  boolean fLite,
                                                                                                                  @Context
                                                                                                                  javax.ws.rs.core.UriInfo uriInfo)

Register SSE event listener for this named query.

Parameters:

fLite - flag specifying whether to register for lite or full events

uriInfo - UriInfo for the invoked resource method

Returns:

the EventOutput that will be used to send events to the client

executeQuery

protected Collection executeQuery(javax.ws.rs.core.UriInfo uriInfo,
                                  ValueExtractor<Map.Entry,?> extractor,
                                  int nStart,
                                  int cResults,
                                  String sSort)

Returns a collection of extracted values for cache entries that satisfy the criteria expressed by the query.

Parameters:

uriInfo - UriInfo for the invoked resource method

extractor - the extractor to apply to each entry in the result set

nStart - the starting index of result set to be returned

cResults - the size of result set to be returned (page size)

sSort - a string expression that represents sort order

Returns:

the cache entries that satisfy the criteria defined by this named query

keys

protected Set keys(javax.ws.rs.core.UriInfo uriInfo)

Return the keys of cache entries that satisfy the named query criteria.

Parameters:

uriInfo - UriInfo for invoked resource method

Returns:

filtered key set