TemplateHolder (GigaSpaces XAP 14.2.0 API)

java.lang.Object
- com.gigaspaces.internal.server.storage.AbstractSpaceItem
- - com.gigaspaces.internal.server.storage.TemplateHolder

All Implemented Interfaces:

IEntryHolder, ISpaceItem, ITemplateHolder, Textualizable, ILockedSubject, ILockObject, ISelfLockingSubject

Direct Known Subclasses:

NotifyTemplateHolder
```
public class TemplateHolder
extends AbstractSpaceItem
implements ITemplateHolder
```
This class represents a template in a J-Space. Each instance of this class contains a reference to the template value plus any other necessary info about the template.
This class extends entryHolder object.

Constructor Summary

Constructors
Constructor and Description
`TemplateHolder(IServerTypeDesc typeDesc, IEntryPacket packet, String uid, long expirationTime, XtnEntry xidOriginated, long scn, int templateOperation, IResponseContext respContext, int operationModifiers)`
`TemplateHolder(IServerTypeDesc typeDesc, ITemplatePacket packet, String uid, long expirationTime, XtnEntry xidOriginated, long scn, int templateOperation, IResponseContext respContext, boolean returnOnlyUid, int operationModifiers, boolean isfifo)`
`TemplateHolder(IServerTypeDesc typeDesc, ITemplatePacket packet, String uid, long expirationTime, XtnEntry xidOriginated, long scn, int templateOperation, IResponseContext respContext, boolean returnOnlyUid, int operationModifiers, boolean isfifo, boolean fromReplication)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addEntryWaitingForTemplate(IEntryHolder entry)`
`void`	`addReadLockOwner(XtnEntry xtn)`
`void`	`addTemplateWaitingForEntry(ITemplateHolder template)`
`boolean`	`anyReadLockXtn()`
`boolean`	`canFinishBatchOperation()`
`void`	`clearReadLockOwners()`
`IEntryHolder`	`createCopy()`
`IEntryHolder`	`createDummy()`
`void`	`dump(Logger logger, String msg)`
`int`	`getAfterOpFilterCode()`
`EntryHolderAggregatorContext`	`getAggregatorContext()`
`AnswerHolder`	`getAnswerHolder()`
`BatchQueryOperationContext`	`getBatchOperationContext()`
`long`	`getChangeExpiration()`
`Collection<ITemplateHolder>`	`getCopyOfTemplatesWaitingForEntry()`
`ICustomQuery`	`getCustomQuery()`
`Collection<IEntryHolder>`	`getEntriesWaitingForTemplate()`
`IEntryData`	`getEntryData()`
`Object`	`getEntryId()`
`SingleExplainPlan`	`getExplainPlan()`
`short[]`	`getExtendedMatchCodes()`
`String`	`getExternalEntryImplClassName()`
`ILockObject`	`getExternalLockObject()` in case the locking object can be derived from the subject WHEN its not the subject itself
`int`	`getFifoThreadPartition()`
`long`	`getFifoXtnNumberOnSearchStart()`
`FilterManager`	`getFilterManager()`
`Object`	`getID()`
`IEntryHolder`	`getMaster()`
`MultipleIdsContext`	`getMultipleIdsContext()`
`String[]`	`getMultipleUids()`
`Collection<SpaceEntryMutator>`	`getMutators()`
`OperationID`	`getOperationID()`
`int`	`getOperationModifiers()`
`int`	`getOrdinalForEntryByIdMultipleOperation()`
`IEntryHolder`	`getOriginalEntryHolder()`
`PendingFifoSearch`	`getPendingFifoSearchObject()`
`int`	`getPreviousVersion()`
`AbstractProjectionTemplate`	`getProjectionTemplate()`
`QueryResultTypeInternal`	`getQueryResultType()`
`boolean`	`getRangeInclusion(int index)`
`Object`	`getRangeValue(int index)`
`List<XtnEntry>`	`getReadLockOwners()`
`IEntryData`	`getRejectedOperationEntry()`
`Throwable`	`getRejectedOpOriginalException()`
`IResponseContext`	`getResponseContext()`
`ShadowEntryHolder`	`getShadow()`
`SpaceContext`	`getSpaceContext()`
`int`	`getTemplateOperation()`
`Collection<ITemplateHolder>`	`getTemplatesWaitingForEntry()`
`int`	`getTokenFieldNumber()`
`ITransactionalEntryData`	`getTxnEntryData()`
`String`	`getUidToOperateBy()`
`IEntryHolder`	`getUpdatedEntry()`
`IEntryPacket`	`getUpdateOperationEntry()`
`UpdateOrWriteContext`	`getUpfdateOrWriteContext()`
`int`	`getWriteLockOperation()`
`XtnEntry`	`getWriteLockOwner()`
`ServerTransaction`	`getWriteLockTransaction()`
`XtnEntry`	`getXidOriginated()`
`ServerTransaction`	`getXidOriginatedTransaction()`
`boolean`	`hasAnswer()`
`boolean`	`hasExtendedMatchCodes()`
`boolean`	`hasPendingRemoteException()`
`boolean`	`hasShadow(boolean safeEntry)`
`boolean`	`isAllValuesIndexSqlQuery()`
`boolean`	`isBatchOperation()`
`boolean`	`isBlobStoreEntry()`
`boolean`	`isChange()`
`boolean`	`isChangeById()`
`boolean`	`isChangeMultiple()`
`boolean`	`isChangeQuery()`
`boolean`	`isDirtyReadRequested()`
`boolean`	`isEmptyTemplate()` returns true if this template represents an empty template.
`boolean`	`isEntryUnderWriteLockXtn()`
`boolean`	`isExclusiveReadLockOperation()` return indication if the template is exclusive read-lock operation
`boolean`	`isExpirationTimeSet()`
`boolean`	`isExpired()`
`boolean`	`isExpired(long limit)`
`boolean`	`isExplicitInsertionToExpirationManager()`
`boolean`	`isFifoGroupPoll()`
`boolean`	`isFifoSearch()` is template relevant for fifo blocking in initial search ?
`boolean`	`isFifoTemplate()`
`boolean`	`isHasWaitingFor()`
`boolean`	`isIdQuery()`
`boolean`	`isIfExist()`
`boolean`	`isInCache()`
`boolean`	`isInExpirationManager()` the template MUST be locked when calling this method.
`boolean`	`isInitialFifoSearchActive()`
`boolean`	`isInitialIfExistSearchActive()` is the initial if-exist search active ?
`boolean`	`isInitiatedEvictionOperation()`
`boolean`	`isMatchByID()` Return true whether this template should match by uid only (if such provided) or with full match regardless present if uid.
`boolean`	`isMaybeUnderXtn()`
`boolean`	`isMemoryOnlySearch()`
`boolean`	`isMultipleIdsOperation()`
`boolean`	`isNonBlockingRead()` return true if this template should perform in non-blocking read
`boolean`	`isNotifyTemplate()`
`static boolean`	`isOptimizedForBlobStoreClear(CacheManager cacheManager, ITemplatePacket templatePacket, TemplateEntryData templateEntryData)`
`boolean`	`isOptimizedForBlobStoreOp(CacheManager cacheManager)`
`boolean`	`isReadCommittedRequested()`
`boolean`	`isReadMultiple()`
`boolean`	`isReadOperation()`
`boolean`	`isReRegisterLeaseOnUpdate()`
`boolean`	`isReturnOnlyUid()`
`boolean`	`isSameEntryInstance(IEntryHolder other)`
`boolean`	`isSecondPhase()` the second phase is reached if the templateHolder enters the cache and is being matched by a different (later) call (thread) this flag is used to avoid sending a response twice to the client.
`boolean`	`isSetSingleOperationExtendedErrorInfo()`
`boolean`	`isSqlQuery()`
`boolean`	`isTakeMultiple()`
`boolean`	`isTakeOperation()`
`boolean`	`isUnstable()`
`boolean`	`isUpdateMultiple()`
`boolean`	`isUpdateOperation()`
`boolean`	`isWriteLockOperation()`
`MatchResult`	`match(CacheManager cacheManager, IEntryHolder entry, int skipAlreadyMatchedFixedPropertyIndex, String skipAlreadyMatchedIndexPath, boolean safeEntry, Context context, RegexCache regexCache)`
`boolean`	`quickReject(Context context, FifoSearch fifoSearch)`
`void`	`removeEntryWaitingForTemplate(IEntryHolder entry)`
`void`	`removePendingFifoSearchObject(boolean disableInitialSearch)` remove the pending search object & if requested disable initial search indicator NOTE- should be done when template is locked
`void`	`removeReadLockOwner(XtnEntry xtn)`
`void`	`removeTemplateWaitingForEntry(ITemplateHolder template)`
`void`	`resetEntryXtnInfo()`
`void`	`resetFifoXtnNumberOnSearchStart()`
`void`	`resetInitialFifoSearchActive()`
`void`	`resetInitialIfExistSearchActive()` reset the _initialIfExistSearchActive indicator
`void`	`resetWriteLockOwner()`
`void`	`resetXidOriginated()`
`void`	`restoreUpdateXtnRollback(IEntryData entryData)`
`void`	`setAggregatorContext(EntryHolderAggregatorContext aggregatorContext)`
`void`	`setAnswerHolder(AnswerHolder answerHolder)`
`void`	`setBatchOperationContext(BatchQueryOperationContext batchOpContext)`
`void`	`setChangeExpiration(long expirationTime)`
`void`	`setCustomQuery(ICustomQuery customQuery)` This method is required for SF case 7017 (https://na6.salesforce.com/5008000000GijmA?srPos=1&srKp=500).
`void`	`setExpirationTime(long expirationTime)`
`void`	`setExpirationTime(long expirationTime, boolean createSnapshot)`
`void`	`setFieldsValues(Object[] fieldsValues, boolean createSnapsht)`
`void`	`setFifoThreadPartition(int nThread)`
`void`	`setFifoXtnNumberOnSearchStart(long xtnnum)`
`void`	`setForAfterOperationFilter(int afterOpFilterCode, SpaceContext sc, FilterManager fm, IEntryPacket updateOperationEntry)`
`void`	`setHasWaitingFor(boolean value)`
`void`	`setID(Object id)`
`void`	`setIfExistForChange()`
`void`	`setInCache()`
`void`	`setInExpirationManager(boolean inManager)` the template MUST be locked when calling this method.
`void`	`setInitialFifoSearchActive()`
`void`	`setInitialIfExistSearchActive()` set the _initialIfExistSearchActive indicator
`void`	`setMemoryOnlySearch(boolean memoryOnly)`
`void`	`setMultipleIdsContext(MultipleIdsContext byIdsContext)`
`void`	`setMutators(Collection<SpaceEntryMutator> mutators)`
`void`	`setNonBlockingRead(boolean val)`
`void`	`setOrdinalForEntryByIdMultipleOperation(int ordinal)`
`void`	`setOtherUpdateUnderXtnEntry(IEntryHolder eh)`
`void`	`setPendingFifoSearchObject(PendingFifoSearch pobj)`
`void`	`setPendingRemoteException(boolean value)`
`void`	`setRejectedOpOriginalExceptionAndEntry(Throwable cause, IEntryData rejectedEntry)`
`void`	`setReRegisterLeaseOnUpdate(boolean value)`
`void`	`setSecondPhase()`
`void`	`setUidToOperateBy(String uid)`
`void`	`setunStable(boolean value)`
`void`	`setUpdatedEntry(IEntryHolder updatedEntry)`
`void`	`setUpdateOrWriteContext(UpdateOrWriteContext ctx)`
`void`	`setWriteLockOperation(int writeLockOperation, boolean createSnapshot)`
`void`	`setWriteLockOwnerAndOperation(XtnEntry writeLockOwner, int writeLockOperation)`
`void`	`setWriteLockOwnerAndOperation(XtnEntry writeLockOwner, int writeLockOperation, boolean createSnapshot)`
`void`	`setWriteLockOwnerOperationAndShadow(XtnEntry writeLockOwner, int writeLockOperation, IEntryHolder otherEh)`
`SQLQuery<?>`	`toSQLQuery(ITypeDesc typeDesc)`
`void`	`updateEntryData(IEntryData newEntryData, long expirationTime)`
`void`	`updateVersionAndExpiration(int versionID, long expiration)`

Methods inherited from class com.gigaspaces.internal.server.storage.AbstractSpaceItem
getClassName, getEvictableLockObject, getExpirationTime, getHandback, getNotifyType, getOrder, getRoutingValue, getSCN, getServerTypeDesc, getUID, getVersionID, hasShadow, isDeleted, isLockSubject, isShadow, isTransient, setDeleted, setMaybeUnderXtn, setOrder, setSCN, setUID, toString, toText

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gigaspaces.internal.server.storage.ITemplateHolder
getExpirationTime

Methods inherited from interface com.gigaspaces.internal.server.storage.IEntryHolder
getHandback, getNotifyType, getOrder, getRoutingValue, hasShadow, isShadow, setOrder, setSCN, setUID

Methods inherited from interface com.gigaspaces.internal.server.storage.ISpaceItem
getClassName, getSCN, getServerTypeDesc, isDeleted, isTransient, setDeleted, setMaybeUnderXtn

Methods inherited from interface com.j_spaces.kernel.locks.ILockObject
isLockSubject

Methods inherited from interface com.j_spaces.kernel.locks.ILockedSubject
getUID

- Constructor Detail
  - TemplateHolder
```
public TemplateHolder(IServerTypeDesc typeDesc,
                      ITemplatePacket packet,
                      String uid,
                      long expirationTime,
                      XtnEntry xidOriginated,
                      long scn,
                      int templateOperation,
                      IResponseContext respContext,
                      boolean returnOnlyUid,
                      int operationModifiers,
                      boolean isfifo,
                      boolean fromReplication)
```
  - TemplateHolder
```
public TemplateHolder(IServerTypeDesc typeDesc,
                      ITemplatePacket packet,
                      String uid,
                      long expirationTime,
                      XtnEntry xidOriginated,
                      long scn,
                      int templateOperation,
                      IResponseContext respContext,
                      boolean returnOnlyUid,
                      int operationModifiers,
                      boolean isfifo)
```
  - TemplateHolder
```
public TemplateHolder(IServerTypeDesc typeDesc,
                      IEntryPacket packet,
                      String uid,
                      long expirationTime,
                      XtnEntry xidOriginated,
                      long scn,
                      int templateOperation,
                      IResponseContext respContext,
                      int operationModifiers)
```
- Method Detail
  - isHasWaitingFor
```
public boolean isHasWaitingFor()
```
    Specified by:
    
    isHasWaitingFor in interface ISpaceItem
  - setHasWaitingFor
```
public void setHasWaitingFor(boolean value)
```
    Specified by:
    
    setHasWaitingFor in interface ISpaceItem
  - isNotifyTemplate
```
public boolean isNotifyTemplate()
```
    Specified by:
    
    isNotifyTemplate in interface ITemplateHolder
  - setExpirationTime
```
public void setExpirationTime(long expirationTime)
```
    Specified by:
    
    setExpirationTime in interface ISpaceItem
    
    Specified by:
    
    setExpirationTime in class AbstractSpaceItem
  - setExpirationTime
```
public void setExpirationTime(long expirationTime,
                              boolean createSnapshot)
```
  - isExpired
```
public boolean isExpired()
```
    Specified by:
    
    isExpired in interface IEntryHolder
  - isExpired
```
public boolean isExpired(long limit)
```
    Specified by:
    
    isExpired in interface IEntryHolder
  - updateVersionAndExpiration
```
public void updateVersionAndExpiration(int versionID,
                                       long expiration)
```
    Specified by:
    
    updateVersionAndExpiration in interface ISpaceItem
  - getTemplateOperation
```
public int getTemplateOperation()
```
    Specified by:
    
    getTemplateOperation in interface ITemplateHolder
  - hasPendingRemoteException
```
public boolean hasPendingRemoteException()
```
  - setPendingRemoteException
```
public void setPendingRemoteException(boolean value)
```
  - getQueryResultType
```
public QueryResultTypeInternal getQueryResultType()
```
    Specified by:
    
    getQueryResultType in interface ITemplateHolder
  - getResponseContext
```
public IResponseContext getResponseContext()
```
    Specified by:
    
    getResponseContext in interface ITemplateHolder
  - getTokenFieldNumber
```
public int getTokenFieldNumber()
```
    Specified by:
    
    getTokenFieldNumber in interface ITemplateHolder
  - isInitialIfExistSearchActive
```
public boolean isInitialIfExistSearchActive()
```
    is the initial if-exist search active ?
    
    Specified by:
    
    isInitialIfExistSearchActive in interface ITemplateHolder
    
    Returns:
    
    _initialIfExistSearchActive indicator
  - setInitialIfExistSearchActive
```
public void setInitialIfExistSearchActive()
```
    set the _initialIfExistSearchActive indicator
    
    Specified by:
    
    setInitialIfExistSearchActive in interface ITemplateHolder
  - resetInitialIfExistSearchActive
```
public void resetInitialIfExistSearchActive()
```
    reset the _initialIfExistSearchActive indicator
    
    Specified by:
    
    resetInitialIfExistSearchActive in interface ITemplateHolder
  - isEmptyTemplate
```
public boolean isEmptyTemplate()
```
    returns true if this template represents an empty template. i.e. this template's type is Object.
    
    Specified by:
    
    isEmptyTemplate in interface ITemplateHolder
  - hasExtendedMatchCodes
```
public boolean hasExtendedMatchCodes()
```
    Specified by:
    
    hasExtendedMatchCodes in interface ITemplateHolder
  - getExtendedMatchCodes
```
public short[] getExtendedMatchCodes()
```
    Specified by:
    
    getExtendedMatchCodes in interface ITemplateHolder
  - isExclusiveReadLockOperation
```
public boolean isExclusiveReadLockOperation()
```
    return indication if the template is exclusive read-lock operation
    
    Specified by:
    
    isExclusiveReadLockOperation in interface ITemplateHolder
    
    Returns:
    
    true if exclusive read-lock
  - isFifoSearch
```
public boolean isFifoSearch()
```
    is template relevant for fifo blocking in initial search ?
    
    Specified by:
    
    isFifoSearch in interface ITemplateHolder
  - isFifoTemplate
```
public boolean isFifoTemplate()
```
    Specified by:
    
    isFifoTemplate in interface ITemplateHolder
  - isIfExist
```
public boolean isIfExist()
```
    Specified by:
    
    isIfExist in interface ITemplateHolder
  - isInCache
```
public boolean isInCache()
```
    Specified by:
    
    isInCache in interface ITemplateHolder
  - setInCache
```
public void setInCache()
```
    Specified by:
    
    setInCache in interface ITemplateHolder
  - isExpirationTimeSet
```
public boolean isExpirationTimeSet()
```
    Specified by:
    
    isExpirationTimeSet in interface ITemplateHolder
  - removePendingFifoSearchObject
```
public void removePendingFifoSearchObject(boolean disableInitialSearch)
```
    remove the pending search object & if requested disable initial search indicator NOTE- should be done when template is locked
    
    Specified by:
    
    removePendingFifoSearchObject in interface ITemplateHolder
  - setPendingFifoSearchObject
```
public void setPendingFifoSearchObject(PendingFifoSearch pobj)
```
    Specified by:
    
    setPendingFifoSearchObject in interface ITemplateHolder
  - getPendingFifoSearchObject
```
public PendingFifoSearch getPendingFifoSearchObject()
```
    Specified by:
    
    getPendingFifoSearchObject in interface ITemplateHolder
  - isInitialFifoSearchActive
```
public boolean isInitialFifoSearchActive()
```
    Specified by:
    
    isInitialFifoSearchActive in interface ITemplateHolder
  - setInitialFifoSearchActive
```
public void setInitialFifoSearchActive()
```
    Specified by:
    
    setInitialFifoSearchActive in interface ITemplateHolder
  - resetInitialFifoSearchActive
```
public void resetInitialFifoSearchActive()
```
  - getFifoXtnNumberOnSearchStart
```
public long getFifoXtnNumberOnSearchStart()
```
    Specified by:
    
    getFifoXtnNumberOnSearchStart in interface ITemplateHolder
  - setFifoXtnNumberOnSearchStart
```
public void setFifoXtnNumberOnSearchStart(long xtnnum)
```
    Specified by:
    
    setFifoXtnNumberOnSearchStart in interface ITemplateHolder
  - resetFifoXtnNumberOnSearchStart
```
public void resetFifoXtnNumberOnSearchStart()
```
    Specified by:
    
    resetFifoXtnNumberOnSearchStart in interface ITemplateHolder
  - isWriteLockOperation
```
public boolean isWriteLockOperation()
```
    Specified by:
    
    isWriteLockOperation in interface ITemplateHolder
  - isReadOperation
```
public boolean isReadOperation()
```
    Specified by:
    
    isReadOperation in interface ITemplateHolder
  - isTakeOperation
```
public boolean isTakeOperation()
```
    Specified by:
    
    isTakeOperation in interface ITemplateHolder
  - isUpdateOperation
```
public boolean isUpdateOperation()
```
    Specified by:
    
    isUpdateOperation in interface ITemplateHolder
  - isInitiatedEvictionOperation
```
public boolean isInitiatedEvictionOperation()
```
    Specified by:
    
    isInitiatedEvictionOperation in interface ITemplateHolder
  - isReadCommittedRequested
```
public boolean isReadCommittedRequested()
```
    Specified by:
    
    isReadCommittedRequested in interface ITemplateHolder
  - isDirtyReadRequested
```
public boolean isDirtyReadRequested()
```
    Specified by:
    
    isDirtyReadRequested in interface ITemplateHolder
  - getFifoThreadPartition
```
public int getFifoThreadPartition()
```
    Specified by:
    
    getFifoThreadPartition in interface ITemplateHolder
  - setFifoThreadPartition
```
public void setFifoThreadPartition(int nThread)
```
    Specified by:
    
    setFifoThreadPartition in interface ITemplateHolder
  - isSecondPhase
```
public boolean isSecondPhase()
```
    the second phase is reached if the templateHolder enters the cache and is being matched by a different (later) call (thread) this flag is used to avoid sending a response twice to the client.
    
    Specified by:
    
    isSecondPhase in interface ITemplateHolder
    
    Returns:
    
    the current phase.
    
    See Also:
    
    com.gigaspaces.internal.server.space.SpaceEngine#notifyReceiver(ITemplateHolder, IEntryPacket, Exception, boolean)
  - setSecondPhase
```
public void setSecondPhase()
```
    Specified by:
    
    setSecondPhase in interface ITemplateHolder
    
    See Also:
    
    isSecondPhase()
  - hasAnswer
```
public boolean hasAnswer()
```
    Specified by:
    
    hasAnswer in interface ITemplateHolder
  - getAnswerHolder
```
public AnswerHolder getAnswerHolder()
```
    Specified by:
    
    getAnswerHolder in interface ITemplateHolder
  - setAnswerHolder
```
public void setAnswerHolder(AnswerHolder answerHolder)
```
    Specified by:
    
    setAnswerHolder in interface ITemplateHolder
  - setInExpirationManager
```
public void setInExpirationManager(boolean inManager)
```
    the template MUST be locked when calling this method.
    
    Specified by:
    
    setInExpirationManager in interface ITemplateHolder
  - isInExpirationManager
```
public boolean isInExpirationManager()
```
    the template MUST be locked when calling this method.
    
    Specified by:
    
    isInExpirationManager in interface ITemplateHolder
  - isExplicitInsertionToExpirationManager
```
public boolean isExplicitInsertionToExpirationManager()
```
    Specified by:
    
    isExplicitInsertionToExpirationManager in interface ITemplateHolder
  - getExternalEntryImplClassName
```
public String getExternalEntryImplClassName()
```
    Specified by:
    
    getExternalEntryImplClassName in interface ITemplateHolder
  - getOperationID
```
public OperationID getOperationID()
```
    Specified by:
    
    getOperationID in interface ITemplateHolder
  - resetXidOriginated
```
public void resetXidOriginated()
```
    Specified by:
    
    resetXidOriginated in interface IEntryHolder
    
    Parameters:
    
    m_XidOriginated - the m_XidOriginated to set
  - getXidOriginated
```
public XtnEntry getXidOriginated()
```
    Specified by:
    
    getXidOriginated in interface ISpaceItem
  - getXidOriginatedTransaction
```
public ServerTransaction getXidOriginatedTransaction()
```
    Specified by:
    
    getXidOriginatedTransaction in interface ISpaceItem
    
    Returns:
    
    the m_XidOriginated transaction
  - isMaybeUnderXtn
```
public boolean isMaybeUnderXtn()
```
    Specified by:
    
    isMaybeUnderXtn in interface ISpaceItem
    
    Overrides:
    
    isMaybeUnderXtn in class AbstractSpaceItem
  - setNonBlockingRead
```
public void setNonBlockingRead(boolean val)
```
    Specified by:
    
    setNonBlockingRead in interface ITemplateHolder
  - isNonBlockingRead
```
public boolean isNonBlockingRead()
```
    return true if this template should perform in non-blocking read
    
    Specified by:
    
    isNonBlockingRead in interface ITemplateHolder
  - getRangeValue
```
public Object getRangeValue(int index)
```
    Specified by:
    
    getRangeValue in interface ITemplateHolder
  - getRangeInclusion
```
public boolean getRangeInclusion(int index)
```
    Specified by:
    
    getRangeInclusion in interface ITemplateHolder
  - dump
```
public void dump(Logger logger,
                 String msg)
```
    Overrides:
    
    dump in class AbstractSpaceItem
  - isMatchByID
```
public boolean isMatchByID()
```
    Return true whether this template should match by uid only (if such provided) or with full match regardless present if uid.
    
    Specified by:
    
    isMatchByID in interface ITemplateHolder
  - getEntryId
```
public Object getEntryId()
```
    Specified by:
    
    getEntryId in interface IEntryHolder
    
    Overrides:
    
    getEntryId in class AbstractSpaceItem
  - getUidToOperateBy
```
public String getUidToOperateBy()
```
    Specified by:
    
    getUidToOperateBy in interface ISpaceItem
  - setUidToOperateBy
```
public void setUidToOperateBy(String uid)
```
    Specified by:
    
    setUidToOperateBy in interface ITemplateHolder
  - getMultipleUids
```
public String[] getMultipleUids()
```
    Specified by:
    
    getMultipleUids in interface ITemplateHolder
  - isReturnOnlyUid
```
public boolean isReturnOnlyUid()
```
    Specified by:
    
    isReturnOnlyUid in interface ITemplateHolder
  - getUpdatedEntry
```
public IEntryHolder getUpdatedEntry()
```
    Specified by:
    
    getUpdatedEntry in interface ITemplateHolder
  - setUpdatedEntry
```
public void setUpdatedEntry(IEntryHolder updatedEntry)
```
    Specified by:
    
    setUpdatedEntry in interface ITemplateHolder
  - setReRegisterLeaseOnUpdate
```
public void setReRegisterLeaseOnUpdate(boolean value)
```
    Specified by:
    
    setReRegisterLeaseOnUpdate in interface ITemplateHolder
  - isReRegisterLeaseOnUpdate
```
public boolean isReRegisterLeaseOnUpdate()
```
    Specified by:
    
    isReRegisterLeaseOnUpdate in interface ITemplateHolder
  - getOperationModifiers
```
public int getOperationModifiers()
```
    Specified by:
    
    getOperationModifiers in interface ITemplateHolder
  - getEntryData
```
public IEntryData getEntryData()
```
    Specified by:
    
    getEntryData in interface ISpaceItem
  - isMemoryOnlySearch
```
public boolean isMemoryOnlySearch()
```
    Specified by:
    
    isMemoryOnlySearch in interface ITemplateHolder
  - setMemoryOnlySearch
```
public void setMemoryOnlySearch(boolean memoryOnly)
```
    Specified by:
    
    setMemoryOnlySearch in interface ITemplateHolder
  - getCustomQuery
```
public ICustomQuery getCustomQuery()
```
    Specified by:
    
    getCustomQuery in interface ITemplateHolder
  - setCustomQuery
```
public void setCustomQuery(ICustomQuery customQuery)
```
    This method is required for SF case 7017 (https://na6.salesforce.com/5008000000GijmA?srPos=1&srKp=500). The customer is using this internal API with our approval, until we provide our own solution.
  - toSQLQuery
```
public SQLQuery<?> toSQLQuery(ITypeDesc typeDesc)
```
    Specified by:
    
    toSQLQuery in interface ITemplateHolder
  - setID
```
public void setID(Object id)
```
    Specified by:
    
    setID in interface ITemplateHolder
  - getID
```
public Object getID()
```
    Specified by:
    
    getID in interface ITemplateHolder
  - match
```
public MatchResult match(CacheManager cacheManager,
                         IEntryHolder entry,
                         int skipAlreadyMatchedFixedPropertyIndex,
                         String skipAlreadyMatchedIndexPath,
                         boolean safeEntry,
                         Context context,
                         RegexCache regexCache)
```
    Specified by:
    
    match in interface ITemplateHolder
  - quickReject
```
public boolean quickReject(Context context,
                           FifoSearch fifoSearch)
```
    Specified by:
    
    quickReject in interface ITemplateHolder
  - getTxnEntryData
```
public ITransactionalEntryData getTxnEntryData()
```
    Specified by:
    
    getTxnEntryData in interface IEntryHolder
  - anyReadLockXtn
```
public boolean anyReadLockXtn()
```
    Specified by:
    
    anyReadLockXtn in interface IEntryHolder
  - getReadLockOwners
```
public List<XtnEntry> getReadLockOwners()
```
    Specified by:
    
    getReadLockOwners in interface IEntryHolder
  - addReadLockOwner
```
public void addReadLockOwner(XtnEntry xtn)
```
    Specified by:
    
    addReadLockOwner in interface IEntryHolder
  - removeReadLockOwner
```
public void removeReadLockOwner(XtnEntry xtn)
```
    Specified by:
    
    removeReadLockOwner in interface IEntryHolder
  - clearReadLockOwners
```
public void clearReadLockOwners()
```
    Specified by:
    
    clearReadLockOwners in interface IEntryHolder
  - getWriteLockOwner
```
public XtnEntry getWriteLockOwner()
```
    Specified by:
    
    getWriteLockOwner in interface IEntryHolder
  - isEntryUnderWriteLockXtn
```
public boolean isEntryUnderWriteLockXtn()
```
    Specified by:
    
    isEntryUnderWriteLockXtn in interface IEntryHolder
  - getWriteLockOperation
```
public int getWriteLockOperation()
```
    Specified by:
    
    getWriteLockOperation in interface IEntryHolder
  - getWriteLockTransaction
```
public ServerTransaction getWriteLockTransaction()
```
    Specified by:
    
    getWriteLockTransaction in interface IEntryHolder
  - getTemplatesWaitingForEntry
```
public Collection<ITemplateHolder> getTemplatesWaitingForEntry()
```
    Specified by:
    
    getTemplatesWaitingForEntry in interface IEntryHolder
  - getCopyOfTemplatesWaitingForEntry
```
public Collection<ITemplateHolder> getCopyOfTemplatesWaitingForEntry()
```
    Specified by:
    
    getCopyOfTemplatesWaitingForEntry in interface IEntryHolder
  - addTemplateWaitingForEntry
```
public void addTemplateWaitingForEntry(ITemplateHolder template)
```
    Specified by:
    
    addTemplateWaitingForEntry in interface IEntryHolder
  - removeTemplateWaitingForEntry
```
public void removeTemplateWaitingForEntry(ITemplateHolder template)
```
    Specified by:
    
    removeTemplateWaitingForEntry in interface IEntryHolder
  - getMaster
```
public IEntryHolder getMaster()
```
    Specified by:
    
    getMaster in interface IEntryHolder
  - setFieldsValues
```
public void setFieldsValues(Object[] fieldsValues,
                            boolean createSnapsht)
```
  - updateEntryData
```
public void updateEntryData(IEntryData newEntryData,
                            long expirationTime)
```
    Specified by:
    
    updateEntryData in interface IEntryHolder
  - resetEntryXtnInfo
```
public void resetEntryXtnInfo()
```
    Specified by:
    
    resetEntryXtnInfo in interface IEntryHolder
  - resetWriteLockOwner
```
public void resetWriteLockOwner()
```
    Specified by:
    
    resetWriteLockOwner in interface IEntryHolder
  - setWriteLockOperation
```
public void setWriteLockOperation(int writeLockOperation,
                                  boolean createSnapshot)
```
    Specified by:
    
    setWriteLockOperation in interface IEntryHolder
  - setWriteLockOwnerAndOperation
```
public void setWriteLockOwnerAndOperation(XtnEntry writeLockOwner,
                                          int writeLockOperation)
```
    Specified by:
    
    setWriteLockOwnerAndOperation in interface IEntryHolder
  - setWriteLockOwnerAndOperation
```
public void setWriteLockOwnerAndOperation(XtnEntry writeLockOwner,
                                          int writeLockOperation,
                                          boolean createSnapshot)
```
    Specified by:
    
    setWriteLockOwnerAndOperation in interface IEntryHolder
  - setWriteLockOwnerOperationAndShadow
```
public void setWriteLockOwnerOperationAndShadow(XtnEntry writeLockOwner,
                                                int writeLockOperation,
                                                IEntryHolder otherEh)
```
    Specified by:
    
    setWriteLockOwnerOperationAndShadow in interface IEntryHolder
  - hasShadow
```
public boolean hasShadow(boolean safeEntry)
```
    Specified by:
    
    hasShadow in interface IEntryHolder
    
    Specified by:
    
    hasShadow in class AbstractSpaceItem
  - getShadow
```
public ShadowEntryHolder getShadow()
```
    Specified by:
    
    getShadow in interface IEntryHolder
  - restoreUpdateXtnRollback
```
public void restoreUpdateXtnRollback(IEntryData entryData)
```
    Specified by:
    
    restoreUpdateXtnRollback in interface IEntryHolder
  - setOtherUpdateUnderXtnEntry
```
public void setOtherUpdateUnderXtnEntry(IEntryHolder eh)
```
    Specified by:
    
    setOtherUpdateUnderXtnEntry in interface IEntryHolder
  - createCopy
```
public IEntryHolder createCopy()
```
    Specified by:
    
    createCopy in interface IEntryHolder
  - createDummy
```
public IEntryHolder createDummy()
```
    Specified by:
    
    createDummy in interface IEntryHolder
  - isUnstable
```
public boolean isUnstable()
```
    Specified by:
    
    isUnstable in interface IEntryHolder
  - setunStable
```
public void setunStable(boolean value)
```
    Specified by:
    
    setunStable in interface IEntryHolder
  - getPreviousVersion
```
public int getPreviousVersion()
```
    Specified by:
    
    getPreviousVersion in interface ITemplateHolder
  - getAfterOpFilterCode
```
public int getAfterOpFilterCode()
```
    Specified by:
    
    getAfterOpFilterCode in interface ITemplateHolder
  - getUpdateOperationEntry
```
public IEntryPacket getUpdateOperationEntry()
```
    Specified by:
    
    getUpdateOperationEntry in interface ITemplateHolder
  - getSpaceContext
```
public SpaceContext getSpaceContext()
```
    Specified by:
    
    getSpaceContext in interface ITemplateHolder
  - getFilterManager
```
public FilterManager getFilterManager()
```
    Specified by:
    
    getFilterManager in interface ITemplateHolder
  - setForAfterOperationFilter
```
public void setForAfterOperationFilter(int afterOpFilterCode,
                                       SpaceContext sc,
                                       FilterManager fm,
                                       IEntryPacket updateOperationEntry)
```
    Specified by:
    
    setForAfterOperationFilter in interface ITemplateHolder
  - isFifoGroupPoll
```
public boolean isFifoGroupPoll()
```
    Specified by:
    
    isFifoGroupPoll in interface ITemplateHolder
  - isChange
```
public boolean isChange()
```
    Specified by:
    
    isChange in interface ITemplateHolder
  - isChangeById
```
public boolean isChangeById()
```
    Specified by:
    
    isChangeById in interface ITemplateHolder
  - setMutators
```
public void setMutators(Collection<SpaceEntryMutator> mutators)
```
    Specified by:
    
    setMutators in interface ITemplateHolder
  - getMutators
```
public Collection<SpaceEntryMutator> getMutators()
```
    Specified by:
    
    getMutators in interface ITemplateHolder
  - setChangeExpiration
```
public void setChangeExpiration(long expirationTime)
```
    Specified by:
    
    setChangeExpiration in interface ITemplateHolder
  - getAggregatorContext
```
public EntryHolderAggregatorContext getAggregatorContext()
```
    Specified by:
    
    getAggregatorContext in interface ITemplateHolder
  - setAggregatorContext
```
public void setAggregatorContext(EntryHolderAggregatorContext aggregatorContext)
```
    Specified by:
    
    setAggregatorContext in interface ITemplateHolder
  - getChangeExpiration
```
public long getChangeExpiration()
```
    Specified by:
    
    getChangeExpiration in interface ITemplateHolder
  - setIfExistForChange
```
public void setIfExistForChange()
```
    Specified by:
    
    setIfExistForChange in interface ITemplateHolder
  - getRejectedOpOriginalException
```
public Throwable getRejectedOpOriginalException()
```
    Specified by:
    
    getRejectedOpOriginalException in interface ITemplateHolder
  - setRejectedOpOriginalExceptionAndEntry
```
public void setRejectedOpOriginalExceptionAndEntry(Throwable cause,
                                                   IEntryData rejectedEntry)
```
    Specified by:
    
    setRejectedOpOriginalExceptionAndEntry in interface ITemplateHolder
  - getRejectedOperationEntry
```
public IEntryData getRejectedOperationEntry()
```
    Specified by:
    
    getRejectedOperationEntry in interface ITemplateHolder
  - isSetSingleOperationExtendedErrorInfo
```
public boolean isSetSingleOperationExtendedErrorInfo()
```
    Specified by:
    
    isSetSingleOperationExtendedErrorInfo in interface ITemplateHolder
  - getEntriesWaitingForTemplate
```
public Collection<IEntryHolder> getEntriesWaitingForTemplate()
```
    Specified by:
    
    getEntriesWaitingForTemplate in interface ITemplateHolder
  - addEntryWaitingForTemplate
```
public void addEntryWaitingForTemplate(IEntryHolder entry)
```
    Specified by:
    
    addEntryWaitingForTemplate in interface ITemplateHolder
  - removeEntryWaitingForTemplate
```
public void removeEntryWaitingForTemplate(IEntryHolder entry)
```
    Specified by:
    
    removeEntryWaitingForTemplate in interface ITemplateHolder
  - isBatchOperation
```
public boolean isBatchOperation()
```
    Specified by:
    
    isBatchOperation in interface ITemplateHolder
  - isReadMultiple
```
public boolean isReadMultiple()
```
    Specified by:
    
    isReadMultiple in interface ITemplateHolder
  - isTakeMultiple
```
public boolean isTakeMultiple()
```
    Specified by:
    
    isTakeMultiple in interface ITemplateHolder
  - getBatchOperationContext
```
public BatchQueryOperationContext getBatchOperationContext()
```
    Specified by:
    
    getBatchOperationContext in interface ITemplateHolder
  - setBatchOperationContext
```
public void setBatchOperationContext(BatchQueryOperationContext batchOpContext)
```
    Specified by:
    
    setBatchOperationContext in interface ITemplateHolder
  - canFinishBatchOperation
```
public boolean canFinishBatchOperation()
```
    Specified by:
    
    canFinishBatchOperation in interface ITemplateHolder
  - isChangeMultiple
```
public boolean isChangeMultiple()
```
    Specified by:
    
    isChangeMultiple in interface ITemplateHolder
  - isChangeQuery
```
public boolean isChangeQuery()
```
    Specified by:
    
    isChangeQuery in interface ITemplateHolder
  - getProjectionTemplate
```
public AbstractProjectionTemplate getProjectionTemplate()
```
    Specified by:
    
    getProjectionTemplate in interface ITemplateHolder
  - isIdQuery
```
public boolean isIdQuery()
```
    Specified by:
    
    isIdQuery in interface ITemplateHolder
  - isMultipleIdsOperation
```
public boolean isMultipleIdsOperation()
```
    Specified by:
    
    isMultipleIdsOperation in interface ITemplateHolder
  - getMultipleIdsContext
```
public MultipleIdsContext getMultipleIdsContext()
```
    Specified by:
    
    getMultipleIdsContext in interface ITemplateHolder
  - setMultipleIdsContext
```
public void setMultipleIdsContext(MultipleIdsContext byIdsContext)
```
    Specified by:
    
    setMultipleIdsContext in interface ITemplateHolder
  - isUpdateMultiple
```
public boolean isUpdateMultiple()
```
    Specified by:
    
    isUpdateMultiple in interface ITemplateHolder
  - setOrdinalForEntryByIdMultipleOperation
```
public void setOrdinalForEntryByIdMultipleOperation(int ordinal)
```
    Specified by:
    
    setOrdinalForEntryByIdMultipleOperation in interface ITemplateHolder
  - getOrdinalForEntryByIdMultipleOperation
```
public int getOrdinalForEntryByIdMultipleOperation()
```
    Specified by:
    
    getOrdinalForEntryByIdMultipleOperation in interface ITemplateHolder
  - getUpfdateOrWriteContext
```
public UpdateOrWriteContext getUpfdateOrWriteContext()
```
    Specified by:
    
    getUpfdateOrWriteContext in interface ITemplateHolder
  - setUpdateOrWriteContext
```
public void setUpdateOrWriteContext(UpdateOrWriteContext ctx)
```
    Specified by:
    
    setUpdateOrWriteContext in interface ITemplateHolder
  - isSameEntryInstance
```
public boolean isSameEntryInstance(IEntryHolder other)
```
    Specified by:
    
    isSameEntryInstance in interface IEntryHolder
  - isBlobStoreEntry
```
public boolean isBlobStoreEntry()
```
    Specified by:
    
    isBlobStoreEntry in interface IEntryHolder
  - getOriginalEntryHolder
```
public IEntryHolder getOriginalEntryHolder()
```
    Specified by:
    
    getOriginalEntryHolder in interface IEntryHolder
  - isAllValuesIndexSqlQuery
```
public boolean isAllValuesIndexSqlQuery()
```
    Specified by:
    
    isAllValuesIndexSqlQuery in interface ITemplateHolder
  - isSqlQuery
```
public boolean isSqlQuery()
```
    Specified by:
    
    isSqlQuery in interface ITemplateHolder
  - getExternalLockObject
```
public ILockObject getExternalLockObject()
```
    Description copied from interface: ILockedSubject
    
    in case the locking object can be derived from the subject WHEN its not the subject itself
    
    Specified by:
    
    getExternalLockObject in interface ILockedSubject
    
    Returns:
    
    the lock object
  - isOptimizedForBlobStoreOp
```
public boolean isOptimizedForBlobStoreOp(CacheManager cacheManager)
```
    Specified by:
    
    isOptimizedForBlobStoreOp in interface ITemplateHolder
  - isOptimizedForBlobStoreClear
```
public static boolean isOptimizedForBlobStoreClear(CacheManager cacheManager,
                                                   ITemplatePacket templatePacket,
                                                   TemplateEntryData templateEntryData)
```
  - getExplainPlan
```
public SingleExplainPlan getExplainPlan()
```

Class TemplateHolder

Constructor Summary

Method Summary

Methods inherited from class com.gigaspaces.internal.server.storage.AbstractSpaceItem

Methods inherited from class java.lang.Object

Methods inherited from interface com.gigaspaces.internal.server.storage.ITemplateHolder

Methods inherited from interface com.gigaspaces.internal.server.storage.IEntryHolder

Methods inherited from interface com.gigaspaces.internal.server.storage.ISpaceItem

Methods inherited from interface com.j_spaces.kernel.locks.ILockObject

Methods inherited from interface com.j_spaces.kernel.locks.ILockedSubject

Constructor Detail

TemplateHolder

TemplateHolder

TemplateHolder

Method Detail

isHasWaitingFor

setHasWaitingFor

isNotifyTemplate

setExpirationTime

setExpirationTime

isExpired

isExpired

updateVersionAndExpiration

getTemplateOperation

hasPendingRemoteException

setPendingRemoteException

getQueryResultType

getResponseContext

getTokenFieldNumber

isInitialIfExistSearchActive

setInitialIfExistSearchActive

resetInitialIfExistSearchActive

isEmptyTemplate

hasExtendedMatchCodes

getExtendedMatchCodes

isExclusiveReadLockOperation

isFifoSearch

isFifoTemplate

isIfExist

isInCache

setInCache

isExpirationTimeSet

removePendingFifoSearchObject

setPendingFifoSearchObject

getPendingFifoSearchObject

isInitialFifoSearchActive

setInitialFifoSearchActive

resetInitialFifoSearchActive

getFifoXtnNumberOnSearchStart

setFifoXtnNumberOnSearchStart

resetFifoXtnNumberOnSearchStart

isWriteLockOperation

isReadOperation

isTakeOperation

isUpdateOperation

isInitiatedEvictionOperation

isReadCommittedRequested

isDirtyReadRequested

getFifoThreadPartition

setFifoThreadPartition

isSecondPhase

setSecondPhase

hasAnswer

getAnswerHolder

setAnswerHolder

setInExpirationManager

isInExpirationManager

isExplicitInsertionToExpirationManager

getExternalEntryImplClassName

getOperationID

resetXidOriginated

getXidOriginated

getXidOriginatedTransaction

isMaybeUnderXtn

setNonBlockingRead

isNonBlockingRead

getRangeValue

getRangeInclusion

dump

isMatchByID