org.apache.geode.cache.query.internal.cq

Class ServerCQImpl

java.lang.Object

org.apache.geode.cache.query.internal.cq.CqQueryImpl

org.apache.geode.cache.query.internal.cq.ServerCQImpl

All Implemented Interfaces:

java.io.Serializable, org.apache.geode.cache.query.CqQuery, org.apache.geode.cache.query.internal.cq.InternalCqQuery, org.apache.geode.cache.query.internal.cq.ServerCQ, org.apache.geode.DataSerializable

public class ServerCQImpl
extends CqQueryImpl
implements org.apache.geode.DataSerializable, org.apache.geode.cache.query.internal.cq.ServerCQ

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.geode.cache.query.internal.cq.CqQueryImpl

CqQueryImpl.TestHook

Nested classes/interfaces inherited from interface org.apache.geode.DataSerializable

org.apache.geode.DataSerializable.Replaceable

Field Summary

Fields

Modifier and Type	Field and Description
boolean	cqResultKeysInitialized To indicate if the CQ results key cache is initialized.

Fields inherited from class org.apache.geode.cache.query.internal.cq.CqQueryImpl

cqName, cqService, cqState, isDurable, query, queryString, regionName, stats, testHook

Constructor Summary

Constructors

Constructor and Description
ServerCQImpl()
ServerCQImpl(CqServiceImpl cqService, java.lang.String cqName, java.lang.String queryString, boolean isDurable, java.lang.String serverCqName)

Method Summary

Modifier and Type	Method and Description
void	addToCqResultKeys(java.lang.Object key)
protected void	cleanup() Clears the resource used by CQ.
void	close() Closes the Query.
void	close(boolean sendRequestToServer)
void	execute()
<E> org.apache.geode.cache.query.CqResults<E>	executeWithInitialResults()
void	fromData(java.io.DataInput in)
org.apache.geode.internal.cache.tier.sockets.CacheClientNotifier	getCacheClientNotifier() Get CacheClientNotifier of this CqQuery.
org.apache.geode.internal.cache.tier.sockets.ClientProxyMembershipID	getClientProxyId()
org.apache.geode.cache.query.CqAttributes	getCqAttributes()
org.apache.geode.cache.query.CqAttributesMutator	getCqAttributesMutator()
java.util.Set<java.lang.Object>	getCqResultKeyCache() For Test use only.
int	getCqResultKeysSize() Returns the size of the CQ Result key cache.
java.lang.Long	getFilterID()
java.lang.String	getServerCqName()
boolean	isOldValueRequiredForQueryProcessing(java.lang.Object key)
boolean	isPartOfCqResult(java.lang.Object key) Returns if the passed key is part of the CQs result set.
boolean	isPR()
void	registerCq(org.apache.geode.internal.cache.tier.sockets.ClientProxyMembershipID p_clientProxyId, org.apache.geode.internal.cache.tier.sockets.CacheClientNotifier p_ccn, int p_cqState)
void	removeFromCqResultKeys(java.lang.Object key, boolean isTokenMode)
void	setCqResultsCacheInitialized()
void	setFilterID(java.lang.Long filterID)
void	setName(java.lang.String cqName)
void	stop() Stop or pause executing the query.
void	toData(java.io.DataOutput out)

Methods inherited from class org.apache.geode.cache.query.internal.cq.CqQueryImpl

getCqBaseRegion, getName, getQuery, getQueryString, getRegionName, getState, getStatistics, getVsdStats, isClosed, isClosing, isDurable, isRunning, isStopped, setCqService, setCqState

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.geode.cache.query.internal.cq.InternalCqQuery

getCqBaseRegion, getName, getQueryString, getRegionName, getState, getVsdStats, isDurable, setCqService, setCqState

Methods inherited from interface org.apache.geode.cache.query.CqQuery

getQuery, getStatistics, isClosed, isRunning, isStopped

Field Detail

cqResultKeysInitialized

public volatile boolean cqResultKeysInitialized

To indicate if the CQ results key cache is initialized.

Constructor Detail

ServerCQImpl

public ServerCQImpl(CqServiceImpl cqService,
                    java.lang.String cqName,
                    java.lang.String queryString,
                    boolean isDurable,
                    java.lang.String serverCqName)

ServerCQImpl

public ServerCQImpl()

Method Detail

getFilterID

public java.lang.Long getFilterID()

Specified by:

getFilterID in interface org.apache.geode.cache.query.internal.cq.ServerCQ

setFilterID

public void setFilterID(java.lang.Long filterID)

Specified by:

setFilterID in interface org.apache.geode.cache.query.internal.cq.ServerCQ

setName

public void setName(java.lang.String cqName)

Specified by:

setName in interface org.apache.geode.cache.query.internal.cq.InternalCqQuery

Overrides:

setName in class CqQueryImpl

getServerCqName

public java.lang.String getServerCqName()

Specified by:

getServerCqName in interface org.apache.geode.cache.query.internal.cq.InternalCqQuery

Specified by:

getServerCqName in class CqQueryImpl

registerCq

public void registerCq(org.apache.geode.internal.cache.tier.sockets.ClientProxyMembershipID p_clientProxyId,
                       org.apache.geode.internal.cache.tier.sockets.CacheClientNotifier p_ccn,
                       int p_cqState)
                throws org.apache.geode.cache.query.CqException,
                       org.apache.geode.cache.query.RegionNotFoundException

Specified by:

registerCq in interface org.apache.geode.cache.query.internal.cq.ServerCQ

Throws:

org.apache.geode.cache.query.CqException

org.apache.geode.cache.query.RegionNotFoundException

getCqResultKeyCache

public java.util.Set<java.lang.Object> getCqResultKeyCache()

For Test use only.

Returns:

CQ Results Cache.

isPartOfCqResult

public boolean isPartOfCqResult(java.lang.Object key)

Returns if the passed key is part of the CQs result set. This method needs to be called once the CQ result key caching is completed (cqResultsCacheInitialized is true).

Returns:

true if key is in the Results Cache.

addToCqResultKeys

public void addToCqResultKeys(java.lang.Object key)

Specified by:

addToCqResultKeys in interface org.apache.geode.cache.query.internal.cq.ServerCQ

removeFromCqResultKeys

public void removeFromCqResultKeys(java.lang.Object key,
                                   boolean isTokenMode)

Specified by:

removeFromCqResultKeys in interface org.apache.geode.cache.query.internal.cq.ServerCQ

setCqResultsCacheInitialized

public void setCqResultsCacheInitialized()

Specified by:

setCqResultsCacheInitialized in interface org.apache.geode.cache.query.internal.cq.ServerCQ

getCqResultKeysSize

public int getCqResultKeysSize()

Returns the size of the CQ Result key cache.

Returns:

size of CQ Result key cache.

isOldValueRequiredForQueryProcessing

public boolean isOldValueRequiredForQueryProcessing(java.lang.Object key)

Specified by:

isOldValueRequiredForQueryProcessing in interface org.apache.geode.cache.query.internal.cq.ServerCQ

close

public void close()
           throws org.apache.geode.cache.query.CqClosedException,
                  org.apache.geode.cache.query.CqException

Closes the Query. On Client side, sends the cq close request to server. On Server side, takes care of repository cleanup.

Specified by:

close in interface org.apache.geode.cache.query.CqQuery

Specified by:

close in interface org.apache.geode.cache.query.internal.cq.InternalCqQuery

Throws:

org.apache.geode.cache.query.CqClosedException

org.apache.geode.cache.query.CqException

close

public void close(boolean sendRequestToServer)
           throws org.apache.geode.cache.query.CqClosedException,
                  org.apache.geode.cache.query.CqException

Specified by:

close in interface org.apache.geode.cache.query.internal.cq.InternalCqQuery

Specified by:

close in interface org.apache.geode.cache.query.internal.cq.ServerCQ

Throws:

org.apache.geode.cache.query.CqClosedException

org.apache.geode.cache.query.CqException

getClientProxyId

public org.apache.geode.internal.cache.tier.sockets.ClientProxyMembershipID getClientProxyId()

Specified by:

getClientProxyId in interface org.apache.geode.cache.query.internal.cq.ServerCQ

getCacheClientNotifier

public org.apache.geode.internal.cache.tier.sockets.CacheClientNotifier getCacheClientNotifier()

Get CacheClientNotifier of this CqQuery.

Returns:

CacheClientNotifier

cleanup

protected void cleanup()
                throws org.apache.geode.cache.query.CqException

Clears the resource used by CQ.

Specified by:

cleanup in class CqQueryImpl

Throws:

org.apache.geode.cache.query.CqException

stop

public void stop()
          throws org.apache.geode.cache.query.CqClosedException,
                 org.apache.geode.cache.query.CqException

Stop or pause executing the query.

Specified by:

stop in interface org.apache.geode.cache.query.CqQuery

Specified by:

stop in interface org.apache.geode.cache.query.internal.cq.InternalCqQuery

Specified by:

stop in interface org.apache.geode.cache.query.internal.cq.ServerCQ

Throws:

org.apache.geode.cache.query.CqClosedException

org.apache.geode.cache.query.CqException

fromData

public void fromData(java.io.DataInput in)
              throws java.io.IOException,
                     java.lang.ClassNotFoundException

Specified by:

fromData in interface org.apache.geode.DataSerializable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

toData

public void toData(java.io.DataOutput out)
            throws java.io.IOException

Specified by:

toData in interface org.apache.geode.DataSerializable

Throws:

java.io.IOException

isPR

public boolean isPR()

Specified by:

isPR in interface org.apache.geode.cache.query.internal.cq.ServerCQ

getCqAttributes

public org.apache.geode.cache.query.CqAttributes getCqAttributes()

Specified by:

getCqAttributes in interface org.apache.geode.cache.query.CqQuery

getCqAttributesMutator

public org.apache.geode.cache.query.CqAttributesMutator getCqAttributesMutator()

Specified by:

getCqAttributesMutator in interface org.apache.geode.cache.query.CqQuery

executeWithInitialResults

public <E> org.apache.geode.cache.query.CqResults<E> executeWithInitialResults()
                                                                        throws org.apache.geode.cache.query.CqClosedException,
                                                                               org.apache.geode.cache.query.RegionNotFoundException,
                                                                               org.apache.geode.cache.query.CqException

Specified by:

executeWithInitialResults in interface org.apache.geode.cache.query.CqQuery

Throws:

org.apache.geode.cache.query.CqClosedException

org.apache.geode.cache.query.RegionNotFoundException

org.apache.geode.cache.query.CqException

execute

public void execute()
             throws org.apache.geode.cache.query.CqClosedException,
                    org.apache.geode.cache.query.RegionNotFoundException,
                    org.apache.geode.cache.query.CqException

Specified by:

execute in interface org.apache.geode.cache.query.CqQuery

Throws:

org.apache.geode.cache.query.CqClosedException

org.apache.geode.cache.query.RegionNotFoundException

org.apache.geode.cache.query.CqException