com.j_spaces.jdbc.builder

Class QueryTemplatePacket

java.lang.Object

com.gigaspaces.internal.serialization.AbstractExternalizable

com.gigaspaces.internal.transport.AbstractEntryPacket

com.gigaspaces.internal.transport.EntryPacket

com.j_spaces.core.ExternalEntryPacket

com.j_spaces.core.ExternalTemplatePacket

com.j_spaces.jdbc.builder.QueryTemplatePacket

All Implemented Interfaces:

RawEntry, ISwapExternalizable, IEntryPacket, ITemplatePacket, ITransportPacket, Textualizable, SmartExternalizable, Externalizable, Serializable, Cloneable

Direct Known Subclasses:

UnionTemplatePacket

public class QueryTemplatePacket
extends ExternalTemplatePacket

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AggregationSet	_aggregationSet
protected boolean	_allIndexValuesQuery
static IQueryIndexScanner	_dummyNullIndexScanner
protected boolean	_preparedForSpace

Fields inherited from class com.j_spaces.core.ExternalTemplatePacket

_extendedMatchCodes, _rangeValues, _rangeValuesInclusion

Fields inherited from class com.j_spaces.core.ExternalEntryPacket

_implClassName

Fields inherited from class com.gigaspaces.internal.transport.EntryPacket

_returnOnlyUIDs, _typeName

Fields inherited from class com.gigaspaces.internal.transport.AbstractEntryPacket

_entryType, _entryTypeCode, _typeDesc, _typeDescChecksum

Constructor Summary

Constructors

Constructor and Description
QueryTemplatePacket()
QueryTemplatePacket(QueryTableData table, QueryResultTypeInternal queryResultType)
QueryTemplatePacket(QueryTableData table, QueryResultTypeInternal queryResultType, IContainsItemsCustomQuery containsItemsQuery)
QueryTemplatePacket(QueryTableData table, QueryResultTypeInternal queryResultType, String fieldName, Range range)
QueryTemplatePacket(QueryTemplatePacket template)

Method Summary

Modifier and Type	Method and Description
QueryTemplatePacket	and(QueryTemplatePacket template) Merge given templates into one template.
QueryTemplatePacket	and(UnionTemplatePacket template) Merge given templates into one template.
QueryTemplatePacket	buildAndPacket(QueryTemplatePacket packet)
QueryTemplatePacket	buildOrPacket(QueryTemplatePacket packet)
boolean	enabledSmartExternalizableWithReference() Indicates if smart externalizable serialization should detect shared references of instances within serializtion context
AggregationSet	getAggregationSet()
ExplainPlan	getExplainPlan()
Set<String>	getMultipleUids()
AbstractProjectionTemplate	getProjectionTemplate()
QueryResultTypeInternal	getQueryResultType()
HashMap<String,Range>	getRanges() Converts the external entry to a map of ranges
Object	getRoutingFieldValue()
void	intersectRanges(QueryTemplatePacket template) Merge given templates into one template.
protected void	intersectUids(QueryTemplatePacket template)
boolean	isAllIndexValuesSqlQuery()
boolean	isAlwaysEmpty()
boolean	isComplex() Method to indicate whether this query is complex - false only if the template can be translated to a space query without post processing some space operations don't support complex queries
boolean	isTransient()
protected boolean	matches(IEntryPacket entryPacket)
boolean	matches(JoinedEntry joinedEntry)
void	prepareForSpace(ITypeDesc typeDesc) Convert the ranges to a single space template
void	prepareForUnion(ITypeDesc typeDesc) Temporary method used only for "OR" queries.
IQueryResultSet<IEntryPacket>	read(ISpaceProxy space, AbstractDMLQuery query, Transaction txn, int modifiers, int maxResults)
IQueryResultSet<IEntryPacket>	read(ISpaceProxy space, Transaction txn, long timeout, int modifiers, boolean ifExists, int maxResults, int minEntriesToWaitFor)
protected void	readExternal(ObjectInput in, PlatformLogicalVersion version)
void	readFromSwap(ObjectInput in)
IQueryResultSet<IEntryPacket>	readMultiple(ISpaceProxy space, Transaction txn, int maxResults, int modifiers)
void	setAggregationSet(AggregationSet aggregationSet)
void	setAlwaysEmpty(boolean isAlwaysEmpty)
void	setEntryType(EntryType objectType)
void	setExplainPlan(ExplainPlan explainPlan)
void	setExtendedMatchCode(int index, short eq)
void	setMultipleUids(Set<String> multipleUids)
void	setProjectionTemplate(AbstractProjectionTemplate projectionTemplate)
void	setQueryResultType(QueryResultTypeInternal queryResultType)
void	setRangeValue(int index, Object range)
void	setRangeValueInclusion(int index, boolean include)
void	setRouting(Object routing) Sets the routing value for the template.
ArrayList<IEntryPacket>	take(IJSpace space, Object routing, AbstractProjectionTemplate projectionTemplate, Transaction txn, long timeout, int modifiers, boolean ifExists, int maxResults, int minEntriesToWaitFor, QueryResultTypeInternal resultType)
QueryTemplatePacket	union(QueryTemplatePacket packet)
QueryTemplatePacket	union(UnionTemplatePacket composite)
protected void	writeExternal(ObjectOutput out, PlatformLogicalVersion version)
void	writeToSwap(ObjectOutput out)

Methods inherited from class com.j_spaces.core.ExternalTemplatePacket

clone, getExtendedMatchCodes, getRangeValues, getRangeValuesInclusion, isIdQuery, isIdsQuery, isTemplateQuery, supportExtendedMatching, validate

Methods inherited from class com.j_spaces.core.ExternalEntryPacket

getExternalEntryImplClassName, getPacketType, toObject

Methods inherited from class com.gigaspaces.internal.transport.EntryPacket

getCustomQuery, getDynamicProperties, getFieldValue, getFieldValues, getMultipleUIDs, getTTL, getTypeName, getUID, getVersion, hasFixedPropertiesArray, isFifo, isNoWriteLease, isReturnOnlyUids, setCustomQuery, setDynamicProperties, setFieldsValues, setFieldValue, setMultipleUIDs, setReturnOnlyUIDs, setTTL, setUID, setVersion

Methods inherited from class com.gigaspaces.internal.transport.AbstractEntryPacket

equals, getCodebase, getEntryType, getID, getIdImpl, getOperationID, getPreviousVersion, getPropertyValue, getTypeDescChecksum, getTypeDescriptor, hashCode, hasPreviousVersion, isExternalizableEntryPacket, isSerializeTypeDesc, readExternalImpl, setOperationID, setPreviousVersion, setPropertyValue, setSerializeTypeDesc, setTypeDesc, supportsTypeDescChecksum, toObject, toObject, toObject, toString, toText, validateStorageType, writeExternalImpl

Methods inherited from class com.gigaspaces.internal.serialization.AbstractExternalizable

readExternal, writeExternal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gigaspaces.internal.transport.ITemplatePacket

getTemplateRoutingValue, isBroadcast, isReturnOnlyUids, setDynamicProperties, setReturnOnlyUIDs

Methods inherited from interface com.gigaspaces.internal.transport.IEntryPacket

allNullFieldValues, getID, getPreviousVersion, getTTL, hasFixedPropertiesArray, hasPreviousVersion, isExternalizableEntryPacket, isHybrid, setCustomQuery, setPreviousVersion, setTTL, setUID

Methods inherited from interface com.gigaspaces.internal.transport.ITransportPacket

getCodebase, getCustomQuery, getDynamicProperties, getEntryType, getExternalEntryImplClassName, getFieldValue, getFieldValues, getMultipleUIDs, getOperationID, getPacketType, getPropertyValue, getTypeDescChecksum, getTypeDescriptor, getTypeName, getUID, getVersion, isFifo, isNoWriteLease, isSerializeTypeDesc, setFieldsValues, setFieldValue, setMultipleUIDs, setOperationID, setPropertyValue, setSerializeTypeDesc, setTypeDesc, setVersion, supportsTypeDescChecksum, toObject, toObject, toObject, toObject

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Field Detail

_preparedForSpace

protected boolean _preparedForSpace

_aggregationSet

protected AggregationSet _aggregationSet

_allIndexValuesQuery

protected boolean _allIndexValuesQuery

_dummyNullIndexScanner

public static final IQueryIndexScanner _dummyNullIndexScanner

Constructor Detail

QueryTemplatePacket

public QueryTemplatePacket()

QueryTemplatePacket

public QueryTemplatePacket(QueryTableData table,
                           QueryResultTypeInternal queryResultType)

QueryTemplatePacket

public QueryTemplatePacket(QueryTableData table,
                           QueryResultTypeInternal queryResultType,
                           String fieldName,
                           Range range)

QueryTemplatePacket

public QueryTemplatePacket(QueryTableData table,
                           QueryResultTypeInternal queryResultType,
                           IContainsItemsCustomQuery containsItemsQuery)

QueryTemplatePacket

public QueryTemplatePacket(QueryTemplatePacket template)

Method Detail

isTransient

public boolean isTransient()

Specified by:

isTransient in interface ITransportPacket

Overrides:

isTransient in class EntryPacket

prepareForSpace

public void prepareForSpace(ITypeDesc typeDesc)

Convert the ranges to a single space template

prepareForUnion

public void prepareForUnion(ITypeDesc typeDesc)

Temporary method used only for "OR" queries. Should be united with the prepareForSpace

getRanges

public HashMap<String,Range> getRanges()

Converts the external entry to a map of ranges

isAlwaysEmpty

public boolean isAlwaysEmpty()

setAlwaysEmpty

public void setAlwaysEmpty(boolean isAlwaysEmpty)

isComplex

public boolean isComplex()

Method to indicate whether this query is complex - false only if the template can be translated to a space query without post processing some space operations don't support complex queries

buildAndPacket

public QueryTemplatePacket buildAndPacket(QueryTemplatePacket packet)

and

public QueryTemplatePacket and(QueryTemplatePacket template)

Merge given templates into one template.

and

public QueryTemplatePacket and(UnionTemplatePacket template)

Merge given templates into one template. for example: x=3 and (y=5 or z=8) ==> (x=3 and y=5) or (x=3 and z=8)

intersectUids

protected void intersectUids(QueryTemplatePacket template)

intersectRanges

public void intersectRanges(QueryTemplatePacket template)

Merge given templates into one template. If merge fails - the templates are attached to the original exp nodes

getMultipleUids

public Set<String> getMultipleUids()

setMultipleUids

public void setMultipleUids(Set<String> multipleUids)

setExtendedMatchCode

public void setExtendedMatchCode(int index,
                                 short eq)

setRangeValue

public void setRangeValue(int index,
                          Object range)

setRangeValueInclusion

public void setRangeValueInclusion(int index,
                                   boolean include)

setEntryType

public void setEntryType(EntryType objectType)

getQueryResultType

public QueryResultTypeInternal getQueryResultType()

Specified by:

getQueryResultType in interface ITemplatePacket

Overrides:

getQueryResultType in class ExternalTemplatePacket

setQueryResultType

public void setQueryResultType(QueryResultTypeInternal queryResultType)

buildOrPacket

public QueryTemplatePacket buildOrPacket(QueryTemplatePacket packet)

union

public QueryTemplatePacket union(UnionTemplatePacket composite)

union

public QueryTemplatePacket union(QueryTemplatePacket packet)

readMultiple

public IQueryResultSet<IEntryPacket> readMultiple(ISpaceProxy space,
                                                  Transaction txn,
                                                  int maxResults,
                                                  int modifiers)
                                           throws Exception

Throws:

Exception

getRoutingFieldValue

public Object getRoutingFieldValue()

Specified by:

getRoutingFieldValue in interface ITransportPacket

Overrides:

getRoutingFieldValue in class ExternalTemplatePacket

setRouting

public void setRouting(Object routing)

Sets the routing value for the template.

getProjectionTemplate

public AbstractProjectionTemplate getProjectionTemplate()

Specified by:

getProjectionTemplate in interface ITemplatePacket

Overrides:

getProjectionTemplate in class ExternalTemplatePacket

setProjectionTemplate

public void setProjectionTemplate(AbstractProjectionTemplate projectionTemplate)

Specified by:

setProjectionTemplate in interface ITemplatePacket

Overrides:

setProjectionTemplate in class ExternalTemplatePacket

getAggregationSet

public AggregationSet getAggregationSet()

setAggregationSet

public void setAggregationSet(AggregationSet aggregationSet)

read

public IQueryResultSet<IEntryPacket> read(ISpaceProxy space,
                                          AbstractDMLQuery query,
                                          Transaction txn,
                                          int modifiers,
                                          int maxResults)
                                   throws Exception

Throws:

Exception

read

public IQueryResultSet<IEntryPacket> read(ISpaceProxy space,
                                          Transaction txn,
                                          long timeout,
                                          int modifiers,
                                          boolean ifExists,
                                          int maxResults,
                                          int minEntriesToWaitFor)
                                   throws Exception

Throws:

Exception

take

public ArrayList<IEntryPacket> take(IJSpace space,
                                    Object routing,
                                    AbstractProjectionTemplate projectionTemplate,
                                    Transaction txn,
                                    long timeout,
                                    int modifiers,
                                    boolean ifExists,
                                    int maxResults,
                                    int minEntriesToWaitFor,
                                    QueryResultTypeInternal resultType)
                             throws RemoteException,
                                    TransactionException,
                                    UnusableEntryException,
                                    InterruptedException

Throws:

RemoteException

TransactionException

UnusableEntryException

InterruptedException

matches

protected boolean matches(IEntryPacket entryPacket)

matches

public boolean matches(JoinedEntry joinedEntry)

isAllIndexValuesSqlQuery

public boolean isAllIndexValuesSqlQuery()

Specified by:

isAllIndexValuesSqlQuery in interface ITemplatePacket

Overrides:

isAllIndexValuesSqlQuery in class ExternalTemplatePacket

writeToSwap

public void writeToSwap(ObjectOutput out)
                 throws IOException

Specified by:

writeToSwap in interface ISwapExternalizable

Overrides:

writeToSwap in class ExternalTemplatePacket

Throws:

IOException

readFromSwap

public void readFromSwap(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readFromSwap in interface ISwapExternalizable

Overrides:

readFromSwap in class ExternalTemplatePacket

Throws:

IOException

ClassNotFoundException

enabledSmartExternalizableWithReference

public boolean enabledSmartExternalizableWithReference()

Description copied from interface: SmartExternalizable

Indicates if smart externalizable serialization should detect shared references of instances within serializtion context

writeExternal

protected void writeExternal(ObjectOutput out,
                             PlatformLogicalVersion version)
                      throws IOException

Overrides:

writeExternal in class ExternalTemplatePacket

Throws:

IOException

readExternal

protected void readExternal(ObjectInput in,
                            PlatformLogicalVersion version)
                     throws IOException,
                            ClassNotFoundException

Overrides:

readExternal in class ExternalTemplatePacket

Throws:

IOException

ClassNotFoundException

setExplainPlan

public void setExplainPlan(ExplainPlan explainPlan)

getExplainPlan

public ExplainPlan getExplainPlan()