com.amazon.carbonado

Interface Query.Controller

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, java.io.Serializable

All Known Implementing Classes:

Query.Timeout

Enclosing interface:

Query<S extends Storable>

public static interface Query.Controller
extends java.io.Serializable, java.io.Closeable

Controller instance can be used to abort query operations.

Example:

 Storage<UserInfo> users = ...
 long count = users.query("name = ?").count(Query.Timeout.seconds(10));
 

Method Summary

Methods

Modifier and Type	Method and Description
void	begin() Called by query when it begins, possibly multiple times.
void	close() Always called by query when finished, even when it fails.
void	continueCheck() Periodically called by query to determine if it should continue.
long	getTimeout() Returns a non-negative value if controller imposes an absolute upper bound on query execution time.
java.util.concurrent.TimeUnit	getTimeoutUnit() Returns the unit for the timeout, if applicable.

Method Detail

getTimeout

long getTimeout()

Returns a non-negative value if controller imposes an absolute upper bound on query execution time.

getTimeoutUnit

java.util.concurrent.TimeUnit getTimeoutUnit()

Returns the unit for the timeout, if applicable.

begin

void begin()

Called by query when it begins, possibly multiple times. Implementation is required to be idempotent and ignore multiple invocations.

continueCheck

void continueCheck()
                   throws FetchException

Periodically called by query to determine if it should continue.

Throws:

FetchException

close

void close()

Always called by query when finished, even when it fails. Implementation is required to be idempotent and ignore multiple invocations.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable