Package adams.flow.control

Class Rejector

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.core.AbstractActor

adams.flow.control.AbstractControlActor

adams.flow.control.AbstractTee

adams.flow.control.Tee

adams.flow.control.Rejector

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, Pausable, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, FlowPauseStateListener, VariableChangeListener, AtomicExecution, Actor, ActorHandler, ActorWithConditionalEquivalent, ActorWithTimedEquivalent, ControlActor, ErrorHandler, Flushable, InputConsumer, MutableActorHandler, OutputProducer, SubFlowWrapUp, Serializable, Comparable

public class Rejector
extends Tee

Rejects data containers with errors attached. The errors get tee-ed off as log entries. Instead of using the full name of the actor as 'source' in the log entries, a custom 'source' value can be supplied.

Input/output:
- accepts:
adams.data.container.DataContainer
adams.data.NotesHandler
- generates:
adams.flow.core.Unknown


Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-name <java.lang.String> (property: name)
    The name of the actor.
    default: Rejector
 

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 

-skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 

-stop-flow-on-error (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
 

-tee <adams.flow.core.AbstractActor> (property: teeActor)
    The actor to siphon-off the tokens to.
    default: adams.flow.control.Sequence -actor adams.flow.sink.Null
 

-log-source <java.lang.String> (property: logSource)
    The value to use as 'source' field in the log entries; the actor's full
    name is used by default if left empty.
    default:
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class adams.flow.control.AbstractTee

AbstractTee.TeeSwingWorker

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_LogSource	the source to fill in the log entries.

Fields inherited from class adams.flow.control.AbstractTee

BACKUP_INPUT, m_Actors, m_Asynchronous, m_AsynchronousWorker, m_InputToken, m_MinimumActiveActors, m_OutputToken

Fields inherited from class adams.flow.control.AbstractControlActor

m_Compatibility, m_PauseStateManager, m_SetUpSubActors

Fields inherited from class adams.flow.core.AbstractActor

m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.flow.core.Actor

FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors

Constructor	Description
Rejector()	Default constructor.
Rejector(String name)	Initializes with the specified name.

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the class that the consumer accepts.
protected boolean	canProcessInput(Token token)	Returns whether the token can be processed in the tee actor.
protected Token	createTeeToken(Token token)	Generates the output for the tee actor.
void	defineOptions()	Adds options to the internal list of options.
protected String	doExecute()	Executes the flow item.
String	getLogSource()	Returns the source to use in the log entries.
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 boolean	hasError(Token token)	Checks whether the input notes contain an error.
protected void	initialize()	Initializes the members.
String	logSourceTipText()	Returns the tip text for this property.
void	setLogSource(String value)	Sets the source to use in the log entries.
protected String	setUpTeeActors()	Gets called in the setUp() method.

Methods inherited from class adams.flow.control.Tee

checkTeeActor, checkTeeActors, getActorHandlerInfo, getConditionalEquivalent, getTimedEquivalent

Methods inherited from class adams.flow.control.AbstractTee

actorsTipText, add, add, asynchronousTipText, backupState, check, cleanUp, currentInput, execute, finishBeforeStoppingTipText, finishedAsynchronousExecution, flushExecution, forceVariables, generates, get, getActors, getAsynchronous, getFinishBeforeStopping, getInternalActors, getMinimumActiveActors, getStoppingTimeout, hasInput, hasPendingOutput, indexOf, input, output, processInput, remove, removeAll, restoreState, set, setActors, setAsynchronous, setFinishBeforeStopping, setLoggingLevel, setMinimumActiveActors, setSkip, setStoppingTimeout, setUpSubActors, size, stopExecution, stoppingTimeoutTipText, updateParent, waitForAsynchronousExecution, wrapUp

Methods inherited from class adams.flow.control.AbstractControlActor

active, canInspectOptions, destroy, firstActive, firstInputConsumer, flowPauseStateChanged, isPaused, isSubFlowWrappedUp, lastActive, pauseExecution, preExecute, reset, resumeExecution, setParent, setUp, wrapUpSubFlow

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canPerformSetUpCheck, compareTo, configureLogger, equals, finalUpdateVariables, findVariables, findVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setName, setSilent, setStopFlowOnError, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.flow.core.Actor

cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.flow.core.ActorHandler

firstActive, lastActive

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel, setLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler

canInspectOptions

Field Detail

m_LogSource

protected String m_LogSource

the source to fill in the log entries.

Constructor Detail

Rejector

public Rejector()

Default constructor.

Rejector

public Rejector(String name)

Initializes with the specified name.

Parameters:

name - the name to use

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Overrides:

globalInfo in class Tee

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 OptionHandler

Overrides:

defineOptions in class AbstractTee

initialize

protected void initialize()

Initializes the members.

Overrides:

initialize in class AbstractTee

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface Actor

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractTee

Returns:

null if no info available, otherwise short string

setLogSource

public void setLogSource(String value)

Sets the source to use in the log entries. Empty string uses the full name of the actor as default value.

Parameters:

value - the source

getLogSource

public String getLogSource()

Returns the source to use in the log entries. An empty string uses the full name of the actor as default value.

Returns:

the source

logSourceTipText

public String logSourceTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Specified by:

accepts in interface InputConsumer

Overrides:

accepts in class AbstractTee

Returns:

adams.data.container.DataContainer.class, adams.data.NotesHandler.class

setUpTeeActors

protected String setUpTeeActors()

Gets called in the setUp() method. Returns null if tee-actor is fine, otherwise error message.

Overrides:

setUpTeeActors in class Tee

Returns:

null if everything OK, otherwise error message

hasError

protected boolean hasError(Token token)

Checks whether the input notes contain an error.

Parameters:

token - the input

Returns:

true if the notes contain an error

createTeeToken

protected Token createTeeToken(Token token)

Generates the output for the tee actor.

Overrides:

createTeeToken in class AbstractTee

Parameters:

token - the input

Returns:

the error message token

canProcessInput

protected boolean canProcessInput(Token token)

Returns whether the token can be processed in the tee actor.

Overrides:

canProcessInput in class AbstractTee

Parameters:

token - the token to process

Returns:

true if token can be processed

doExecute

protected String doExecute()

Executes the flow item.

Overrides:

doExecute in class AbstractTee

Returns:

null if everything is fine, otherwise error message