adams.flow.transformer
Class MOAMeasurementsFilter

java.lang.Object
  adams.core.ConsoleObject
      adams.core.option.AbstractOptionHandler
          adams.flow.core.AbstractActor
              adams.flow.transformer.AbstractTransformer
                  adams.flow.transformer.MOAMeasurementsFilter

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Debuggable, DebugOutputHandler, Destroyable, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractActor>, SizeOfHandler, Stoppable, VariableChangeListener, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

public class MOAMeasurementsFilter
extends AbstractTransformer

Filters the measures based on the measurement name. The matching can be inverted as well.

Input/output:
- accepts:
moa.core.Measurement[]
- generates:
moa.core.Measurement[]

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: MOAMeasurementsFilter
 

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

-regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression to use for filtering the measurements.
    default: .*
 

-invert (property: invertMatching)
    Whether to invert the matching sense of the regular expression.
 

Version:

$Revision: 4584 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

protected boolean	m_InvertMatching whether to invert the matching sense.
protected BaseRegExp	m_RegExp the regexp to use on the measurement names.

Fields inherited from class adams.flow.transformer.AbstractTransformer

BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken

Fields inherited from class adams.flow.core.AbstractActor

FILE_EXTENSION, FILE_EXTENSION_GZ, m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_FullName, m_Headless, m_Name, m_Parent, m_Root, m_Self, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

Fields inherited from class adams.core.option.AbstractOptionHandler

m_DebugLevel, m_OptionManager

Constructor Summary

MOAMeasurementsFilter()

Method Summary

Class[]	accepts() Returns the class that the consumer accepts.
void	defineOptions() Adds options to the internal list of options.
protected String	doExecute() Executes the flow item.
Class[]	generates() Returns the class of objects that it generates.
boolean	getInvertMatching() Returns whether the matching sense of the regular expression is inverted.
String	getQuickInfo() Returns a quick info about the actor, which will be displayed in the GUI.
BaseRegExp	getRegExp() Returns the regular expression to use for filtering.
String	globalInfo() Returns a string describing the object.
String	invertMatchingTipText() Returns the tip text for this property.
String	regExpTipText() Returns the tip text for this property.
void	setInvertMatching(boolean value) Sets whether to invert the matching sense of the regular expression.
void	setRegExp(BaseRegExp value) Sets the regular expression to use for filtering.

Methods inherited from class adams.flow.transformer.AbstractTransformer

backupState, execute, hasPendingOutput, input, output, postExecute, reset, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor

annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, debug, destroy, equals, findVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFullName, getName, getNextSibling, getParent, getPreviousSibling, getRoot, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, initialize, isBackedUp, isExecuted, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, preExecute, pruneBackup, pruneBackup, setAnnotations, setErrorHandler, setHeadless, setName, setParent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, debug, debugLevelTipText, finishInit, getDebugLevel, getOptionManager, isDebugOn, newOptionManager, setDebugLevel, toCommandLine, toString

Methods inherited from class adams.core.ConsoleObject

getDebugging, getSystemErr, getSystemOut

Methods inherited from class java.lang.Object

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

Field Detail

m_RegExp

protected BaseRegExp m_RegExp

the regexp to use on the measurement names.

m_InvertMatching

protected boolean m_InvertMatching

whether to invert the matching sense.

Constructor Detail

MOAMeasurementsFilter

public MOAMeasurementsFilter()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in class 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 OptionHandler

Overrides:

defineOptions in class AbstractActor

setRegExp

public void setRegExp(BaseRegExp value)

Sets the regular expression to use for filtering.

Parameters:

value - the expression

getRegExp

public BaseRegExp getRegExp()

Returns the regular expression to use for filtering.

Returns:

the expression

regExpTipText

public String regExpTipText()

Returns the tip text for this property.

Returns:

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

setInvertMatching

public void setInvertMatching(boolean value)

Sets whether to invert the matching sense of the regular expression.

Parameters:

value - if true the matching is inverted

getInvertMatching

public boolean getInvertMatching()

Returns whether the matching sense of the regular expression is inverted.

Returns:

true if the matching is inverted

invertMatchingTipText

public String invertMatchingTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

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

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractActor

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

Returns the class that the consumer accepts.

Returns:

moa.core.Measurement[].class

generates

public Class[] generates()

Returns the class of objects that it generates.

Returns:

moa.core.Measurement[].class

doExecute

protected String doExecute()

Executes the flow item.

Specified by:

doExecute in class AbstractActor

Returns:

null if everything is fine, otherwise error message