org.apache.streams.local.tasks

Class StreamsProviderTask

java.lang.Object

org.apache.streams.local.tasks.BaseStreamsTask

org.apache.streams.local.tasks.StreamsProviderTask

All Implemented Interfaces:

Runnable, DatumStatusCountable, StreamsTask

public class StreamsProviderTask
extends BaseStreamsTask
implements DatumStatusCountable

Field Summary

Fields inherited from class org.apache.streams.local.tasks.BaseStreamsTask

streamConfig

Constructor Summary

Constructors

Constructor and Description
StreamsProviderTask(StreamsProvider provider, BigInteger sequence, org.apache.streams.config.StreamsConfiguration streamConfig) Constructor for a StreamsProvider to execute org.apache.streams.core.StreamsProvider:readNew(BigInteger)
StreamsProviderTask(StreamsProvider provider, boolean perpetual, org.apache.streams.config.StreamsConfiguration streamConfig) Constructor for a StreamsProvider to execute org.apache.streams.core.StreamsProvider:readCurrent()
StreamsProviderTask(StreamsProvider provider, org.joda.time.DateTime start, org.joda.time.DateTime end, org.apache.streams.config.StreamsConfiguration streamConfig) Constructor for a StreamsProvider to execute org.apache.streams.core.StreamsProvider:readRange(DateTime,DateTime)

Method Summary

Modifier and Type	Method and Description
void	addInputQueue(BlockingQueue<StreamsDatum> inputQueue) Add an input Queue for this task.
void	flushResults(StreamsResultSet resultSet)
DatumStatusCounter	getDatumStatusCounter()
boolean	isRunning() Returns true when the task has not completed.
boolean	isWaiting() Returns true if the task is waiting on more data to process
void	run()
void	setSleepTime(long sleepTime)
void	setStreamConfig(org.apache.streams.config.StreamsConfiguration config) Set the configuration object that will shared and passed to all instances of StreamsTask.
void	setStreamsTaskCounter(StreamsTaskCounter counter)
void	setTimeout(int timeout)
void	stopTask() Informs the task to stop.

Methods inherited from class org.apache.streams.local.tasks.BaseStreamsTask

addOutputQueue, addToOutgoingQueue, cloneStreamsDatum, getInputQueues, getNextDatum, getOutputQueues, getStartedAt, getStreamIdentifier, setStartedAt

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamsProviderTask

public StreamsProviderTask(StreamsProvider provider,
                           boolean perpetual,
                           org.apache.streams.config.StreamsConfiguration streamConfig)

Constructor for a StreamsProvider to execute org.apache.streams.core.StreamsProvider:readCurrent()

Parameters:

provider -

StreamsProviderTask

public StreamsProviderTask(StreamsProvider provider,
                           BigInteger sequence,
                           org.apache.streams.config.StreamsConfiguration streamConfig)

Constructor for a StreamsProvider to execute org.apache.streams.core.StreamsProvider:readNew(BigInteger)

Parameters:

provider -

sequence -

StreamsProviderTask

public StreamsProviderTask(StreamsProvider provider,
                           org.joda.time.DateTime start,
                           org.joda.time.DateTime end,
                           org.apache.streams.config.StreamsConfiguration streamConfig)

Constructor for a StreamsProvider to execute org.apache.streams.core.StreamsProvider:readRange(DateTime,DateTime)

Parameters:

provider -

start -

end -

Method Detail

getDatumStatusCounter

public DatumStatusCounter getDatumStatusCounter()

Specified by:

getDatumStatusCounter in interface DatumStatusCountable

setTimeout

public void setTimeout(int timeout)

setSleepTime

public void setSleepTime(long sleepTime)

isWaiting

public boolean isWaiting()

Description copied from interface: StreamsTask

Returns true if the task is waiting on more data to process

Specified by:

isWaiting in interface StreamsTask

Overrides:

isWaiting in class BaseStreamsTask

Returns:

true, if waiting on more data to process

stopTask

public void stopTask()

Description copied from interface: StreamsTask

Informs the task to stop. Tasks may or may not try to empty its inbound queue before halting.

Specified by:

stopTask in interface StreamsTask

addInputQueue

public void addInputQueue(BlockingQueue<StreamsDatum> inputQueue)

Description copied from interface: StreamsTask

Add an input Queue for this task.

Specified by:

addInputQueue in interface StreamsTask

Overrides:

addInputQueue in class BaseStreamsTask

setStreamConfig

public void setStreamConfig(org.apache.streams.config.StreamsConfiguration config)

Description copied from interface: StreamsTask

Set the configuration object that will shared and passed to all instances of StreamsTask.

Specified by:

setStreamConfig in interface StreamsTask

Parameters:

config - optional configuration information

run

public void run()

Specified by:

run in interface Runnable

isRunning

public boolean isRunning()

Description copied from interface: StreamsTask

Returns true when the task has not completed. Returns false otherwise

Specified by:

isRunning in interface StreamsTask

Returns:

true when the task has not completed. Returns false otherwise

flushResults

public void flushResults(StreamsResultSet resultSet)

setStreamsTaskCounter

public void setStreamsTaskCounter(StreamsTaskCounter counter)

Specified by:

setStreamsTaskCounter in interface StreamsTask