public interface CqQuery
| Modifier and Type | Method and Description |
|---|---|
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.
|
<E> CqResults<E> |
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.
|
java.lang.String |
getName()
Get the name of the CQ.
|
Query |
getQuery()
Get the query object generated for this CQs query.
|
java.lang.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.
|
java.lang.String getQueryString()
Query getQuery()
java.lang.String getName()
CqStatistics getStatistics()
CqAttributes getCqAttributes()
CqAttributesCqAttributesMutator 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.java.lang.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.java.lang.IllegalStateException - if the CqQuery is in the RUNNING state
already.CqException - if failed to execute.void stop() throws CqClosedException, CqException
java.lang.IllegalStateException - if the CqQuery is in the STOPPED state
already.CqClosedException - if the CQ is CLOSED.CqExceptionCqState getState()
CqStatevoid 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()