|
GemFire 6.6 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CqQuery
Interface for continuous query. This provides methods for managing a CQ once it is created through the QueryService. The methods allow you to retrieve CQ related information, operate on CQ like execute, stop, close and get the state of the CQ.
Method Summary | ||
---|---|---|
void |
close()
Close the CQ and stop execution. |
|
void |
execute()
Start executing the CQ or if this CQ is stopped earlier, resumes execution of the CQ. |
|
|
executeWithInitialResults()
Starts executing the CQ or, if the CQ is in a stopped state, resumes execution. |
|
CqAttributes |
getCqAttributes()
Get CqAttributes for this CQ. |
|
CqAttributesMutator |
getCqAttributesMutator()
Get CqAttributesMutator for this CQ. |
|
String |
getName()
Get the name of the CQ. |
|
Query |
getQuery()
Get the query object generated for this CQs query. |
|
String |
getQueryString()
Get the original query string that was specified with CQ. |
|
CqState |
getState()
Get the state of the CQ in CqState object form. |
|
CqStatistics |
getStatistics()
Get statistics information for this CQ. |
|
boolean |
isClosed()
This allows to check if the CQ is closed. |
|
boolean |
isDurable()
This allows to check if the CQ is durable. |
|
boolean |
isRunning()
This allows to check if the CQ is in running or active. |
|
boolean |
isStopped()
This allows to check if the CQ is in stopped. |
|
void |
stop()
Stops this CqQuery without releasing resources. |
Method Detail |
---|
String getQueryString()
Query getQuery()
String getName()
CqStatistics getStatistics()
CqAttributes getCqAttributes()
CqAttributes
CqAttributesMutator getCqAttributesMutator()
CqAttributesMutator
<E> CqResults<E> executeWithInitialResults() throws CqClosedException, RegionNotFoundException, CqException
CqClosedException
- if this CqQuery is closed.
RegionNotFoundException
- if the specified region in the
query string is not found.
IllegalStateException
- if the CqQuery is in the RUNNING state
already.
CqException
- if failed to execute and get initial results.void execute() throws CqClosedException, RegionNotFoundException, CqException
CqClosedException
- if this CqQuery is closed.
RegionNotFoundException
- if the specified region in the
query string is not found.
IllegalStateException
- if the CqQuery is in the RUNNING state
already.
CqException
- if failed to execute.void stop() throws CqClosedException, CqException
IllegalStateException
- if the CqQuery is in the STOPPED state
already.
CqClosedException
- if the CQ is CLOSED.
CqException
CqState getState()
CqState
void close() throws CqClosedException, CqException
CqClosedException
- Further calls on this CqQuery instance except
for getState() or getName().
CqException
- - if failure during cleanup of CQ resources.boolean isRunning()
boolean isStopped()
boolean isClosed()
boolean isDurable()
|
GemFire 6.6 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |