Package adams.flow.standalone.rats.input

Class InputWithExternalTransformer

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

adams.flow.standalone.rats.input.InputWithExternalTransformer

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.core.ExternalActorFileHandler, adams.flow.core.ExternalActorHandler, RatInput, Serializable

public class InputWithExternalTransformer
extends AbstractMetaRatInput
implements adams.flow.core.ExternalActorHandler

Meta-receiver that passes the received data through an external transformer before passing it on.

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

-input <adams.flow.standalone.rats.RatInput> (property: input)
    The receiver to wrap.
    default: adams.flow.standalone.rats.DummyInput
 

-file <adams.core.io.FlowFile> (property: actorFile)
    The file containing the external transformer.
    default: ${CWD}
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.io.FlowFile	m_ActorFile	the file the external actor is stored in.
protected adams.flow.core.Actor	m_ExternalActor	the external actor itself.

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

m_Data, m_Input

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
InputWithExternalTransformer()

Method Summary

Modifier and Type	Method	Description
String	actorFileTipText()	Returns the tip text for this property.
void	cleanUpExternalActor()	Cleans up the external actor.
void	defineOptions()	Adds options to the internal list of options.
Class	generates()	Returns the type of data this scheme generates.
adams.core.io.FlowFile	getActorFile()	Returns the file containing the external actor.
adams.flow.core.Actor	getExternalActor()	Returns the internal actor.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
protected String	postReceive()	Passes the collected data from the base-receiver through the callabler transformer.
void	setActorFile(adams.core.io.FlowFile value)	Sets the file containing the external actor.
String	setUp()	Hook method for performing checks at setup time.
String	setUpExternalActor()	Sets up the external actor.

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

callReceive, doReceive, getInput, hasPendingOutput, initialize, initReception, inputTipText, output, preReceive, setInput, setOwner, stopExecution

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

canReceive, check, cleanUp, configureLogger, doWait, getAdditionalInformation, getFullName, getOwner, getQueue, getReceptionInterrupted, handleException, interruptReception, isReceptionRunning, isStopped, receive, shallowCopy, shallowCopy, 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_ActorFile

protected adams.core.io.FlowFile m_ActorFile

the file the external actor is stored in.

m_ExternalActor

protected adams.flow.core.Actor m_ExternalActor

the external actor itself.

Constructor Detail

InputWithExternalTransformer

public InputWithExternalTransformer()

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 AbstractMetaRatInput

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 AbstractMetaRatInput

Returns:

null if no info available, otherwise short string

setActorFile

public void setActorFile(adams.core.io.FlowFile value)

Sets the file containing the external actor.

Specified by:

setActorFile in interface adams.flow.core.ExternalActorFileHandler

Parameters:

value - the actor file

getActorFile

public adams.core.io.FlowFile getActorFile()

Returns the file containing the external actor.

Specified by:

getActorFile in interface adams.flow.core.ExternalActorFileHandler

Returns:

the actor file

actorFileTipText

public String actorFileTipText()

Returns the tip text for this property.

Returns:

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

setUpExternalActor

public String setUpExternalActor()

Sets up the external actor.

Specified by:

setUpExternalActor in interface adams.flow.core.ExternalActorHandler

Returns:

null if everything is fine, otherwise error message

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

setUp

public String setUp()

Hook method for performing checks at setup time.

Specified by:

setUp in interface RatInput

Overrides:

setUp in class AbstractMetaRatInput

Returns:

null if successful, otherwise error message

getExternalActor

public adams.flow.core.Actor getExternalActor()

Returns the internal actor.

Specified by:

getExternalActor in interface adams.flow.core.ExternalActorHandler

Returns:

the actor, null if not available

postReceive

protected String postReceive()

Passes the collected data from the base-receiver through the callabler transformer.

Overrides:

postReceive in class AbstractMetaRatInput

Returns:

null if successful, otherwise error message

See Also:

AbstractMetaRatInput.m_Data

cleanUpExternalActor

public void cleanUpExternalActor()

Cleans up the external actor.

Specified by:

cleanUpExternalActor in interface adams.flow.core.ExternalActorHandler