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

Class GridCacheQueryRequest<K,V>

java.lang.Object

org.gridgain.grid.util.direct.GridTcpCommunicationMessageAdapter

org.gridgain.grid.kernal.processors.cache.GridCacheMessage<K,V>

org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryRequest<K,V>

All Implemented Interfaces:

Serializable, Cloneable, GridCacheDeployable

public class GridCacheQueryRequest<K,V>
extends GridCacheMessage<K,V>
implements GridCacheDeployable

Query request.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheMessage

CACHE_MSG_INDEX_FIELD_NAME, MAX_CACHE_MSG_LOOKUP_INDEX

Fields inherited from class org.gridgain.grid.util.direct.GridTcpCommunicationMessageAdapter

BIT_SET_NOT_READ, BOOLEAN_ARR_NOT_READ, BYTE_ARR_LIST_NOT_READ, BYTE_ARR_NOT_READ, CACHE_VER_NOT_READ, CHAR_ARR_NOT_READ, CLOCK_DELTA_VER_NOT_READ, commState, DHT_PART_EXCHANGE_ID_NOT_READ, DOUBLE_ARR_NOT_READ, DR_INT_REQ_ENTRY_NOT_READ, ENUM_NOT_READ, FLOAT_ARR_NOT_READ, GRID_UUID_NOT_READ, INT_ARR_NOT_READ, LONG_ARR_NOT_READ, LONG_LIST_NOT_READ, MSG_NOT_READ, NULL, SHORT_ARR_NOT_READ, STR_NOT_READ, UUID_NOT_READ, VAL_BYTES_NOT_READ

Constructor Summary

Constructors

Constructor and Description
GridCacheQueryRequest() Required by Externalizable
GridCacheQueryRequest(long id, boolean fields)
GridCacheQueryRequest(long id, String cacheName, GridCacheQueryType type, boolean fields, String clause, String clsName, GridBiPredicate<Object,Object> keyValFilter, GridPredicate<GridCacheEntry<Object,Object>> prjFilter, GridReducer<Object,Object> rdc, GridClosure<Object,Object> trans, int pageSize, boolean incBackups, Object[] args, boolean incMeta)
GridCacheQueryRequest(long id, String cacheName, int pageSize, boolean incBackups, boolean fields, boolean all) Request to load page.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allPages()
Object[]	arguments()
String	cacheName()
boolean	cancel()
String	className()
String	clause()
GridTcpCommunicationMessageAdapter	clone()
protected void	clone0(GridTcpCommunicationMessageAdapter _msg) Clones all fields of the provided message to this.
byte	directType()
boolean	fields()
void	finishUnmarshal(GridCacheContext<K,V> ctx, ClassLoader ldr) This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in GridCacheMessage.prepareMarshal(GridCacheContext) method.
long	id()
boolean	includeBackups()
boolean	includeMetaData()
GridBiPredicate<Object,Object>	keyValueFilter()
int	pageSize()
void	prepareMarshal(GridCacheContext<K,V> ctx) This method is called before the whole message is serialized and is responsible for pre-marshalling state.
GridPredicate<GridCacheEntry<Object,Object>>	projectionFilter()
boolean	readFrom(ByteBuffer buf)
GridReducer<Object,Object>	reducer()
String	toString()
GridClosure<Object,Object>	transformer()
GridCacheQueryType	type()
boolean	writeTo(ByteBuffer buf)

Methods inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheMessage

allowForStartup, classError, deployInfo, ignoreClassErrors, lookupIndex, marshalBooleanLinkedMap, marshalCollection, marshalFilter, marshalInfo, marshalInfos, marshalTx, marshalValuesCollection, messageId, nextIndexId, onClassError, prepare, prepareFilter, prepareObject, prepareObjects, topologyVersion, unmarshalBooleanLinkedMap, unmarshalCollection, unmarshalFilter, unmarshalInfo, unmarshalInfos, unmarshalTx, unmarshalValueBytesCollection

Methods inherited from class org.gridgain.grid.util.direct.GridTcpCommunicationMessageAdapter

arrayIterator, messageReader, messageWriter

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gridgain.grid.kernal.processors.cache.GridCacheDeployable

deployInfo, prepare

Constructor Detail

GridCacheQueryRequest

public GridCacheQueryRequest()

Required by Externalizable

GridCacheQueryRequest

public GridCacheQueryRequest(long id,
                     boolean fields)

Parameters:

id - Request to cancel.

fields - Fields query flag.

GridCacheQueryRequest

public GridCacheQueryRequest(long id,
                     String cacheName,
                     int pageSize,
                     boolean incBackups,
                     boolean fields,
                     boolean all)

Request to load page.

Parameters:

id - Request ID.

cacheName - Cache name.

pageSize - Page size.

incBackups - true if need to include backups.

fields - Fields query flag.

all - Whether to load all pages.

GridCacheQueryRequest

public GridCacheQueryRequest(long id,
                     String cacheName,
                     GridCacheQueryType type,
                     boolean fields,
                     String clause,
                     String clsName,
                     GridBiPredicate<Object,Object> keyValFilter,
                     GridPredicate<GridCacheEntry<Object,Object>> prjFilter,
                     GridReducer<Object,Object> rdc,
                     GridClosure<Object,Object> trans,
                     int pageSize,
                     boolean incBackups,
                     Object[] args,
                     boolean incMeta)

Parameters:

id - Request id.

cacheName - Cache name.

type - Query type.

fields - true if query returns fields.

clause - Query clause.

clsName - Query class name.

keyValFilter - Key-value filter.

prjFilter - Projection filter.

rdc - Reducer.

trans - Transformer.

pageSize - Page size.

incBackups - true if need to include backups.

args - Query arguments.

incMeta - Include meta data or not.

Method Detail

prepareMarshal

public void prepareMarshal(GridCacheContext<K,V> ctx)
                    throws GridException

This method is called before the whole message is serialized and is responsible for pre-marshalling state.

Overrides:

prepareMarshal in class GridCacheMessage<K,V>

Parameters:

ctx - Cache context.

Throws:

GridException - If failed.

finishUnmarshal

public void finishUnmarshal(GridCacheContext<K,V> ctx,
                   ClassLoader ldr)
                     throws GridException

This method is called after the message is deserialized and is responsible for unmarshalling state marshalled in GridCacheMessage.prepareMarshal(GridCacheContext) method.

Overrides:

finishUnmarshal in class GridCacheMessage<K,V>

Parameters:

ctx - Context.

ldr - Class loader.

Throws:

GridException - If failed.

id

public long id()

Returns:

Request id.

cacheName

public String cacheName()

Returns:

Cache name.

type

public GridCacheQueryType type()

Returns:

Query type.

fields

public boolean fields()

Returns:

true if query returns fields.

clause

public String clause()

Returns:

Query clause.

className

public String className()

Returns:

Class name.

includeBackups

public boolean includeBackups()

Returns:

Flag indicating whether to include backups.

cancel

public boolean cancel()

Returns:

Flag indicating that this is cancel request.

keyValueFilter

public GridBiPredicate<Object,Object> keyValueFilter()

Returns:

Key-value filter.

projectionFilter

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

reducer

public GridReducer<Object,Object> reducer()

Returns:

Reducer.

transformer

public GridClosure<Object,Object> transformer()

Returns:

Transformer.

pageSize

public int pageSize()

Returns:

Page size.

arguments

public Object[] arguments()

Returns:

Arguments.

includeMetaData

public boolean includeMetaData()

Returns:

Include meta data or not.

allPages

public boolean allPages()

Returns:

Whether to load all pages.

clone

public GridTcpCommunicationMessageAdapter clone()

Specified by:

clone in class GridTcpCommunicationMessageAdapter

clone0

protected void clone0(GridTcpCommunicationMessageAdapter _msg)

Clones all fields of the provided message to this.

Overrides:

clone0 in class GridCacheMessage<K,V>

Parameters:

_msg - Message to clone from.

writeTo

public boolean writeTo(ByteBuffer buf)

Overrides:

writeTo in class GridCacheMessage<K,V>

Parameters:

buf - Byte buffer.

Returns:

Whether message was fully written.

readFrom

public boolean readFrom(ByteBuffer buf)

Overrides:

readFrom in class GridCacheMessage<K,V>

Parameters:

buf - Byte buffer.

Returns:

Whether message was fully read.

directType

public byte directType()

Specified by:

directType in class GridTcpCommunicationMessageAdapter

Returns:

Message type.

toString

public String toString()

Overrides:

toString in class GridCacheMessage<K,V>