Package adams.flow.standalone.rats.input

Class Storage

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.input.AbstractRatInput

adams.flow.standalone.rats.input.Storage

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.flow.control.StorageUser, RatInput, Serializable

public class Storage
extends AbstractRatInput
implements adams.flow.control.StorageUser

Outputs the specified storage item, if possible

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the item in internal storage.
    default: storage
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	m_Output	the item obtained from the queue.
protected adams.flow.control.StorageName	m_StorageName	the name of the item in the internal storage.

Fields inherited from class adams.flow.standalone.rats.input.AbstractRatInput

m_LoggingPrefix, m_Owner, m_ReceptionInterrupted, m_ReceptionRunning, 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
Storage()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doReceive()	Performs the actual reception of data.
Class	generates()	Returns the type of data this scheme generates.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
adams.flow.control.StorageName	getStorageName()	Returns the name for the item in the internal storage.
String	globalInfo()	Returns a string describing the object.
boolean	hasPendingOutput()	Checks whether any output can be collected.
protected void	initialize()	Initializes the members.
boolean	isUsingStorage()	Returns whether storage items are being used.
Object	output()	Returns the received data.
void	setStorageName(adams.flow.control.StorageName value)	Sets the name for the item in the internal storage.
String	storageNameTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.standalone.rats.input.AbstractRatInput

canReceive, check, cleanUp, configureLogger, doWait, getAdditionalInformation, getFullName, getOwner, getQueue, getReceptionInterrupted, handleException, initReception, interruptReception, isReceptionRunning, isStopped, receive, setOwner, setUp, shallowCopy, shallowCopy, stopExecution, updatePrefix

Methods inherited from class adams.core.option.AbstractOptionHandler

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

Methods inherited from class adams.core.logging.LoggingObject

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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_StorageName

protected adams.flow.control.StorageName m_StorageName

the name of the item in the internal storage.

m_Output

protected Object m_Output

the item obtained from the queue.

Constructor Detail

Storage

public Storage()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractRatInput

setStorageName

public void setStorageName(adams.flow.control.StorageName value)

Sets the name for the item in the internal storage.

Parameters:

value - the name

getStorageName

public adams.flow.control.StorageName getStorageName()

Returns the name for the item in the internal storage.

Returns:

the name

storageNameTipText

public String storageNameTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

isUsingStorage

public boolean isUsingStorage()

Returns whether storage items are being used.

Specified by:

isUsingStorage in interface adams.flow.control.StorageUser

Returns:

true if storage items are used

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRatInput

Returns:

null if no info available, otherwise short string

generates

public Class generates()

Returns the type of data this scheme generates.

Specified by:

generates in interface RatInput

Specified by:

generates in class AbstractRatInput

Returns:

the type of data

doReceive

protected String doReceive()

Performs the actual reception of data.

Specified by:

doReceive in class AbstractRatInput

Returns:

null if successful, otherwise error message

hasPendingOutput

public boolean hasPendingOutput()

Checks whether any output can be collected.

Specified by:

hasPendingOutput in interface RatInput

Specified by:

hasPendingOutput in class AbstractRatInput

Returns:

true if output available

output

public Object output()

Returns the received data.

Specified by:

output in interface RatInput

Specified by:

output in class AbstractRatInput

Returns:

the data