Package adams.flow.transformer

Class SetReportFromFile

  • 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 SetReportFromFile
extends AbstractTransformer
    Loads a report from disk and replaces the current one in the token passing through.

    Input/output:
    - accepts:
       adams.data.report.MutableReportHandler
    - generates:
       adams.flow.core.Unknown


    -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: SetReportFromFile
 
    -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
 
    -report-file <adams.core.io.PlaceholderFile> (property: reportFile)
    The file to load the report from.
    default: ${CWD}
 
    -reader <adams.data.io.input.AbstractReportReader> (property: reader)
    The reader to use for loading the report.
    default: adams.data.io.input.DefaultSimpleReportReader
 
    -update-type <REPLACE|MERGE_CURRENT_WITH_OTHER|MERGE_OTHER_WITH_CURRENT> (property: updateType)
    Determines how to update the report.
    default: REPLACE
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • SetReportFromFile

        public SetReportFromFile()

    • Method Detail

      • setReportFile

        public void setReportFile​(PlaceholderFile value)
        Sets the file to load the report from.
        Parameters:
        value - the file

      • getReportFile

        public PlaceholderFile getReportFile()
        Returns the file to load the report from.
        Returns:
        the file

      • reportFileTipText

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

      • getDefaultReader

        protected AbstractReportReader getDefaultReader()
        Returns the default reader to use.
        Returns:
        the reader

      • setReader

        public void setReader​(AbstractReportReader value)
        Sets the reader to use for reading the report.
        Parameters:
        value - the reader

      • getReader

        public AbstractReportReader getReader()
        Returns the reader in use for reading the report.
        Returns:
        the reader

      • readerTipText

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

      • setUpdateType

        public void setUpdateType​(ReportUpdateType value)
        Sets the report update type.
        Parameters:
        value - the update type

      • getUpdateType

        public ReportUpdateType getUpdateType()
        Returns the report update type.
        Returns:
        the update type

      • updateTypeTipText

        public String updateTypeTipText()
        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:
        the accepted input

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the generated output

      • doExecute

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