org.gridgain.grid.cache.query

Interface GridCacheQueryFuture<T>

All Superinterfaces:

GridFuture<Collection<T>>

All Known Implementing Classes:

GridCacheDistributedFieldsQueryFuture, GridCacheDistributedQueryFuture, GridCacheFieldsQueryErrorFuture, GridCacheLocalFieldsQueryFuture, GridCacheLocalQueryFuture, GridCacheQueryErrorFuture, GridCacheQueryFutureAdapter

public interface GridCacheQueryFuture<T>
extends GridFuture<Collection<T>>

Cache query future returned by query execution. Refer to GridCacheQuery documentation for more information.

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns number of elements that are already fetched and can be returned from next() method without blocking.
boolean	cancel() Cancels this query future and stop receiving any further results for the query associated with this future.
boolean	isDone() Checks if all data is fetched by the query.
T	next() Returns next element from result set.

Methods inherited from interface org.gridgain.grid.GridFuture

chain, concurrentNotify, concurrentNotify, duration, get, get, get, isCancelled, listenAsync, startTime, stopListenAsync, syncNotify, syncNotify

Method Detail

available

int available()
              throws GridException

Returns number of elements that are already fetched and can be returned from next() method without blocking.

Returns:

Number of fetched elements which are available immediately.

Throws:

GridException - In case of error.

next

@Nullable
T next()
       throws GridException

Returns next element from result set.

This is a blocking call which will wait if there are no elements available immediately.

Returns:

Next fetched element or null if all the elements.

Throws:

GridException - If failed.

isDone

boolean isDone()

Checks if all data is fetched by the query.

Specified by:

isDone in interface GridFuture<Collection<T>>

Returns:

True if all data is fetched, false otherwise.

cancel

boolean cancel()
               throws GridException

Cancels this query future and stop receiving any further results for the query associated with this future.

Specified by:

cancel in interface GridFuture<Collection<T>>

Returns:

True if future was canceled (i.e. was not finished prior to this call).

Throws:

GridException - If cancellation failed.