com.amazon.carbonado.cursor

Class ControllerCursor<S>

java.lang.Object

com.amazon.carbonado.cursor.AbstractCursor<S>

com.amazon.carbonado.cursor.ControllerCursor<S>

All Implemented Interfaces:

Cursor<S>

public class ControllerCursor<S>
extends AbstractCursor<S>

Wraps another cursor and periodically calls a controller.

Author:

Brian S O'Neill

Method Summary

Methods

Modifier and Type	Method and Description
static <S> Cursor<S>	apply(Cursor<S> source, Query.Controller controller) Returns a ControllerCursor depending on whether a controller instance is passed in or not.
void	close() Call close to release any resources being held by this cursor.
boolean	hasNext() Returns true if this cursor has more elements.
S	next() Returns the next element from this cursor.

Methods inherited from class com.amazon.carbonado.cursor.AbstractCursor

copyInto, copyInto, skipNext, toList, toList

Methods inherited from class java.lang.Object

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

Method Detail

apply

public static <S> Cursor<S> apply(Cursor<S> source,
                  Query.Controller controller)

Returns a ControllerCursor depending on whether a controller instance is passed in or not.

Parameters:

controller - optional controller which can abort query operation

Throws:

java.lang.IllegalArgumentException - if source is null

hasNext

public boolean hasNext()
                throws FetchException

Description copied from interface: Cursor

Returns true if this cursor has more elements. In other words, returns true if next would return an element rather than throwing an exception.

Throws:

FetchException - if storage layer throws an exception

next

public S next()
       throws FetchException

Description copied from interface: Cursor

Returns the next element from this cursor. This method may be called repeatedly to iterate through the results.

Throws:

FetchException - if storage layer throws an exception

close

public void close()
           throws FetchException

Description copied from interface: Cursor

Call close to release any resources being held by this cursor. Further operations on this cursor will behave as if there are no results.

Throws:

FetchException