Package adams.flow.standalone.rats.output.enqueue

Class PassThrough

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.output.enqueue.AbstractEnqueueGuard

adams.flow.standalone.rats.output.enqueue.PassThrough

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, Serializable

public class PassThrough
extends AbstractEnqueueGuard

Just enqueues the data.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.flow.standalone.rats.output.enqueue.AbstractEnqueueGuard

m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
PassThrough()

Method Summary

Modifier and Type	Method	Description
protected String	doEnqueue(adams.flow.control.StorageQueueHandler handler, Object input, long retrievalDelay)	Enqueues the object if possible.
String	globalInfo()	Returns a string describing the object.

Methods inherited from class adams.flow.standalone.rats.output.enqueue.AbstractEnqueueGuard

enqueue, enqueue, isStopped, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, defineOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Constructor Detail

PassThrough

public PassThrough()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

doEnqueue

protected String doEnqueue(adams.flow.control.StorageQueueHandler handler,
                           Object input,
                           long retrievalDelay)

Enqueues the object if possible.

Specified by:

doEnqueue in class AbstractEnqueueGuard

Parameters:

handler - the queue to use

input - the data to queue

retrievalDelay - the retrieval delay to impose

Returns:

null if successful, otherwise error message