com.streambase.sb.client

Class DequeueResult

java.lang.Object

com.streambase.sb.client.DequeueResult

All Implemented Interfaces:

java.lang.Iterable<Tuple>

Direct Known Subclasses:

SimpleDequeueResult

public abstract class DequeueResult
extends java.lang.Object
implements java.lang.Iterable<Tuple>

Encapsulates the data returned from a dequeue() operation. Contains references to the originating stream, and a list of tuples.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DequeueResult.Interceptor A callback interface that can be implemented by an object that is associated with a StreamBaseClient and which gets used in the course of dequeuing tuples.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSED Status code indicating that the connection was closed
static int	GOOD Status code indicating a normal dequeue
protected Constants.LeadershipStatus	leadershipStatus
protected StreamProperties	props
protected java.lang.Throwable	throwable
static int	TIMEOUT Status code indicating a timeout during dequeue

Method Summary

Modifier and Type	Method and Description
int	checkStatus() Check and return the status of this DequeueResult.
Constants.LeadershipStatus	getLeadershipStatus() Return the leadership status of the server that produced this dequeue result.
Schema	getSchema() Returns the schema for the tuples dequeued, may return null
StreamBaseURI	getServerURI() return the server that produced this DequeueResult.
int	getStatus() Return the status of this DequeueResult.
java.lang.String	getStreamName() Returns the name of the stream on which tuples were dequeued.
StreamProperties	getStreamProperties() Return the StreamProperties for this DequeueResult.
abstract int	getTupleCount() Returns the number of tuples dequeued.
abstract java.util.Iterator<Tuple>	iterator() Returns an iterator of all tuples.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

GOOD

public static final int GOOD

Status code indicating a normal dequeue

See Also:

Constant Field Values

TIMEOUT

public static final int TIMEOUT

Status code indicating a timeout during dequeue

See Also:

Constant Field Values

CLOSED

public static final int CLOSED

Status code indicating that the connection was closed

See Also:

Constant Field Values

props

protected final StreamProperties props

throwable

protected final java.lang.Throwable throwable

leadershipStatus

protected final Constants.LeadershipStatus leadershipStatus

Method Detail

getStreamName

public java.lang.String getStreamName()

Returns the name of the stream on which tuples were dequeued. May return null.

Returns:

the unqualified name of the stream, may return null

getSchema

public Schema getSchema()

Returns the schema for the tuples dequeued, may return null

Returns:

the schema for the tuples dequeued, may return null

Since:

5.0

getStreamProperties

public StreamProperties getStreamProperties()

Return the StreamProperties for this DequeueResult. May return null

Returns:

StreamProperties, may return null

getLeadershipStatus

public Constants.LeadershipStatus getLeadershipStatus()

Return the leadership status of the server that produced this dequeue result.

Returns:

the leadership status of the server that produced this dequeue result.

Since:

5.1

getServerURI

public StreamBaseURI getServerURI()

return the server that produced this DequeueResult. May return null.

Returns:

the server that produced this DequeueResult. May return null.

Since:

5.1

getTupleCount

public abstract int getTupleCount()

Returns the number of tuples dequeued.

Returns:

number of tuples

iterator

public abstract java.util.Iterator<Tuple> iterator()

Returns an iterator of all tuples.

Specified by:

iterator in interface java.lang.Iterable<Tuple>

getStatus

public int getStatus()

Return the status of this DequeueResult.

Returns:

DequeueResult.GOOD if the DequeueResult contains tuples.

See Also:

if need exceptions collected by this DequeueResult

checkStatus

public int checkStatus()
                throws StreamBaseException

Check and return the status of this DequeueResult. Similar to DequeueResult.getStatus() but will throw any exceptions that this DequeueResult has collected.

Returns:

DequeueResult.GOOD if the DequeueResult contains tuples.

Throws:

StreamBaseException - if this DequeueResult has collected any exceptions

Since:

7.0