Package adams.flow.transformer

Class ReportToVariables

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class ReportToVariables
extends AbstractTransformer
    Turns all report fields that match the provided regular expression into variables. An optional prefix can be used to avoid name clashes.

    Input/output:
    - accepts:
       adams.data.report.Report
       adams.data.report.ReportHandler
    - generates:
       adams.data.report.Report
       adams.data.report.ReportHandler


    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ReportToVariables
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default: 
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console.
    default: false
 
    -reg-exp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression that the field names must match in order to be turned 
    into variables.
    default: .*
 
    -prefix <java.lang.String> (property: prefix)
    The optional prefix for the variables (variable = prefix + report field).
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    MathematicalExpression, Serialized Form

    • Field Detail

      • m_RegExp

        protected BaseRegExp m_RegExp
        the regular expression that the fields in the report must match.

      • m_Prefix

        protected String m_Prefix
        the optional prefix for the generated variables.

    • Constructor Detail

      • ReportToVariables

        public ReportToVariables()

    • Method Detail

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expression the field names must match.
        Parameters:
        value - the expression

      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expression the field names must match.
        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.

      • setPrefix

        public void setPrefix​(String value)
        Sets the optional prefix for the variables.
        Parameters:
        value - the prefix

      • getPrefix

        public String getPrefix()
        Returns the optional prefix for the variables.
        Returns:
        the prefix

      • prefixTipText

        public String prefixTipText()
        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.
        Returns:
        adams.data.report.Report.class, adams.data.report.ReportHandler.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        adams.data.report.Report.class, adams.data.report.ReportHandler.class

      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message