Package adams.flow.transformer

Class ChangeReportFieldPrefixes

  • 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 ChangeReportFieldPrefixes
extends AbstractTransformer
    Replaces the specified old prefixes with the new one.

    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: ChangeReportFieldPrefixes
 
    -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 execution at this level gets stopped in case this 
    actor encounters an error; the error gets propagated; useful for critical 
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing 
    actor handler must have this enabled as well.
    default: false
 
    -old-prefix <adams.core.base.BaseString> [-old-prefix ...] (property: oldPrefixes)
    The old prefixes to replace.
    default: 
 
    -new-prefix <java.lang.String> (property: newPrefix)
    The replacement prefix to use.
    default:
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_OldPrefixes

        protected BaseString[] m_OldPrefixes
        the prefixes to match to match.

      • m_NewPrefix

        protected String m_NewPrefix
        the new prefix.

    • Constructor Detail

      • ChangeReportFieldPrefixes

        public ChangeReportFieldPrefixes()

    • Method Detail

      • setOldPrefixes

        public void setOldPrefixes​(BaseString[] value)
        Sets the old prefixes to replace.
        Parameters:
        value - the prefixes

      • getOldPrefixes

        public BaseString[] getOldPrefixes()
        Returns the old prefixes to replace.
        Returns:
        the prefixes

      • oldPrefixesTipText

        public String oldPrefixesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNewPrefix

        public void setNewPrefix​(String value)
        Sets the replacement prefix to use.
        Parameters:
        value - the replacement

      • getNewPrefix

        public String getNewPrefix()
        Returns the replacement prefix in use.
        Returns:
        the replacement

      • newPrefixTipText

        public String newPrefixTipText()
        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