org.gridgain.grid.kernal.processors.cache.query

Class GridCacheQueryAdapter<T>

java.lang.Object

org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryAdapter<T>

All Implemented Interfaces:

GridCacheQuery<T>

public class GridCacheQueryAdapter<T>
extends Object
implements GridCacheQuery<T>

Query adapter.

Field Summary

Fields inherited from interface org.gridgain.grid.cache.query.GridCacheQuery

DFLT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
GridCacheQueryAdapter(GridCacheContext<?,?> cctx, GridCacheQueryType type, GridPredicate<GridCacheEntry<Object,Object>> prjPred, Class<?> cls, String clause, GridBiPredicate<Object,Object> filter, boolean incMeta)
GridCacheQueryAdapter(GridCacheContext<?,?> cctx, GridPredicate<GridCacheEntry<Object,Object>> prjPred, GridCacheQueryType type, GridLogger log, int pageSize, long timeout, boolean keepAll, boolean incBackups, boolean dedup, GridProjection prj, GridBiPredicate<Object,Object> filter, Class<?> cls, String clause, boolean incMeta)

Method Summary

Methods

Modifier and Type	Method and Description
String	clause()
boolean	enableDedup()
GridCacheQuery<T>	enableDedup(boolean dedup) Sets whether or not to deduplicate query result set.
<R> GridCacheQueryFuture<R>	execute(GridClosure<T,R> rmtTransform, Object... args) Executes the query the same way as GridCacheQuery.execute(Object...) method but transforms result remotely.
<R> GridCacheQueryFuture<R>	execute(GridReducer<T,R> rmtReducer, Object... args) Executes the query the same way as GridCacheQuery.execute(Object...) method but reduces result remotely.
GridCacheQueryFuture<T>	execute(Object... args) Executes the query and returns the query future.
boolean	includeBackups()
GridCacheQuery<T>	includeBackups(boolean incBackups) Sets whether or not to include backup entries into query result.
boolean	includeMetadata()
boolean	keepAll()
GridCacheQuery<T>	keepAll(boolean keepAll) Sets whether or not to keep all query results local.
GridCacheQueryMetrics	metrics() Gets metrics for this query.
void	onExecuted(Object res, Throwable err, long startTime, long duration)
int	pageSize()
GridCacheQuery<T>	pageSize(int pageSize) Sets result page size.
GridProjection	projection()
GridCacheQuery<T>	projection(GridProjection prj) Sets optional grid projection to execute this query on.
GridPredicate<GridCacheEntry<Object,Object>>	projectionFilter()
Class<?>	queryClass()
void	resetMetrics() Resets metrics for this query.
<K,V> GridBiPredicate<K,V>	scanFilter()
long	timeout()
GridCacheQuery<T>	timeout(long timeout) Sets query timeout.
GridCacheQueryType	type()
void	validate()

Methods inherited from class java.lang.Object

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

Constructor Detail

GridCacheQueryAdapter

public GridCacheQueryAdapter(GridCacheContext<?,?> cctx,
                     GridCacheQueryType type,
                     @Nullable
                     GridPredicate<GridCacheEntry<Object,Object>> prjPred,
                     @Nullable
                     Class<?> cls,
                     @Nullable
                     String clause,
                     @Nullable
                     GridBiPredicate<Object,Object> filter,
                     boolean incMeta)

Parameters:

cctx - Context.

type - Query type.

cls - Class.

clause - Clause.

filter - Scan filter.

incMeta - Include metadata flag.

prjPred - Cache projection filter.

GridCacheQueryAdapter

public GridCacheQueryAdapter(GridCacheContext<?,?> cctx,
                     GridPredicate<GridCacheEntry<Object,Object>> prjPred,
                     GridCacheQueryType type,
                     GridLogger log,
                     int pageSize,
                     long timeout,
                     boolean keepAll,
                     boolean incBackups,
                     boolean dedup,
                     GridProjection prj,
                     GridBiPredicate<Object,Object> filter,
                     Class<?> cls,
                     String clause,
                     boolean incMeta)

Parameters:

cctx - Context.

prjPred - Cache projection filter.

type - Query type.

log - Logger.

pageSize - Page size.

timeout - Timeout.

keepAll - Keep all flag.

incBackups - Include backups flag.

dedup - Enable dedup flag.

prj - Grid projection.

filter - Key-value filter.

cls - Class.

clause - Clause.

incMeta - Include metadata flag.

Method Detail

projectionFilter

public GridPredicate<GridCacheEntry<Object,Object>> projectionFilter()

Returns:

cache projection filter.

type

public GridCacheQueryType type()

Returns:

Type.

queryClass

@Nullable
public Class<?> queryClass()

Returns:

Class.

clause

@Nullable
public String clause()

Returns:

Clause.

includeMetadata

public boolean includeMetadata()

Returns:

Include metadata flag.

pageSize

public GridCacheQuery<T> pageSize(int pageSize)

Sets result page size. If not provided, GridCacheQuery.DFLT_PAGE_SIZE will be used. Results are returned from queried nodes one page at a tme.

Specified by:

pageSize in interface GridCacheQuery<T>

Parameters:

pageSize - Page size.

Returns:

this query instance for chaining.

pageSize

public int pageSize()

Returns:

Page size.

timeout

public GridCacheQuery<T> timeout(long timeout)

Sets query timeout. 0 means there is no timeout (this is a default value).

Specified by:

timeout in interface GridCacheQuery<T>

Parameters:

timeout - Query timeout.

Returns:

this query instance for chaining.

timeout

public long timeout()

Returns:

Timeout.

keepAll

public GridCacheQuery<T> keepAll(boolean keepAll)

Sets whether or not to keep all query results local. If not - only the current page is kept locally. Default value is true.

Specified by:

keepAll in interface GridCacheQuery<T>

Parameters:

keepAll - Keep results or not.

Returns:

this query instance for chaining.

keepAll

public boolean keepAll()

Returns:

Keep all flag.

includeBackups

public GridCacheQuery<T> includeBackups(boolean incBackups)

Sets whether or not to include backup entries into query result. This flag is false by default.

Specified by:

includeBackups in interface GridCacheQuery<T>

Parameters:

incBackups - Query includeBackups flag.

Returns:

this query instance for chaining.

includeBackups

public boolean includeBackups()

Returns:

Include backups.

enableDedup

public GridCacheQuery<T> enableDedup(boolean dedup)

Sets whether or not to deduplicate query result set. If this flag is true then query result will not contain some key more than once even if several nodes returned entries with the same keys. Default value is false.

Specified by:

enableDedup in interface GridCacheQuery<T>

Parameters:

dedup - Query enableDedup flag.

Returns:

this query instance for chaining.

enableDedup

public boolean enableDedup()

Returns:

Enable dedup flag.

projection

public GridCacheQuery<T> projection(GridProjection prj)

Sets optional grid projection to execute this query on.

Specified by:

projection in interface GridCacheQuery<T>

Parameters:

prj - Projection.

Returns:

this query instance for chaining.

projection

public GridProjection projection()

Returns:

Grid projection.

scanFilter

public <K,V> GridBiPredicate<K,V> scanFilter()

Returns:

Key-value filter.

validate

public void validate()
              throws GridException

Throws:

GridException - If query is invalid.

onExecuted

public void onExecuted(Object res,
              Throwable err,
              long startTime,
              long duration)

Parameters:

res - Query result.

err - Error or null if query executed successfully.

startTime - Start time.

duration - Duration.

execute

public GridCacheQueryFuture<T> execute(@Nullable
                              Object... args)

Executes the query and returns the query future. Caller may decide to iterate over the returned future directly in which case the iterator may block until the next value will become available, or wait for the whole query to finish by calling any of the 'get(..)' methods on the returned future. If GridCacheQuery.keepAll(boolean) flag is set to false, then 'get(..)' methods will only return the last page received, otherwise all pages will be accumulated and returned to user as a collection.

Note that if the passed in grid projection is a local node, then query will be executed locally without distribution to other nodes.

Also note that query state cannot be changed (clause, timeout etc.), except arguments, if this method was called at least once.

Specified by:

execute in interface GridCacheQuery<T>

Parameters:

args - Optional arguments.

Returns:

Future for the query result.

execute

public <R> GridCacheQueryFuture<R> execute(GridReducer<T,R> rmtReducer,
                                  @Nullable
                                  Object... args)

Executes the query the same way as GridCacheQuery.execute(Object...) method but reduces result remotely.

Specified by:

execute in interface GridCacheQuery<T>

Parameters:

rmtReducer - Remote reducer.

args - Optional arguments.

Returns:

Future for the query result.

execute

public <R> GridCacheQueryFuture<R> execute(GridClosure<T,R> rmtTransform,
                                  @Nullable
                                  Object... args)

Executes the query the same way as GridCacheQuery.execute(Object...) method but transforms result remotely.

Specified by:

execute in interface GridCacheQuery<T>

Parameters:

rmtTransform - Remote transformer.

args - Optional arguments.

Returns:

Future for the query result.

metrics

public GridCacheQueryMetrics metrics()

Description copied from interface: GridCacheQuery

Gets metrics for this query.

Specified by:

metrics in interface GridCacheQuery<T>

Returns:

Query metrics.

resetMetrics

public void resetMetrics()

Description copied from interface: GridCacheQuery

Resets metrics for this query.

Specified by:

resetMetrics in interface GridCacheQuery<T>