Package adams.flow.transformer

Class MergeReport

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUser, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class MergeReport
extends AbstractTransformer
implements StorageUser
    Allows the report (or the report of a report handler) passing through to to be merged with another one.

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


    -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: MergeReport
 
    -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
 
    -type <SOURCE|STORAGE> (property: type)
    Determines how to obtain the other report for merging.
    default: SOURCE
 
    -source <adams.flow.core.CallableActorReference> (property: source)
    The source actor to obtain the report from.
    default: 
 
    -storage <adams.flow.control.StorageName> (property: storage)
    The storage item to obtain the report from.
    default: storage
 
    -merge <REPLACE|MERGE_CURRENT_WITH_OTHER|MERGE_OTHER_WITH_CURRENT> (property: merge)
    Determines how to perform the merge.
    default: MERGE_CURRENT_WITH_OTHER
    Version:
    $Revision$
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • MergeReport

        public MergeReport()

    • Method Detail

      • setType

        public void setType​(MergeReport.SourceType value)
        Sets the type of source.
        Parameters:
        value - the type

      • typeTipText

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

      • setSource

        public void setSource​(CallableActorReference value)
        Sets the report source actor.
        Parameters:
        value - the source

      • sourceTipText

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

      • setStorage

        public void setStorage​(StorageName value)
        Sets the report storage item.
        Parameters:
        value - the storage item

      • getStorage

        public StorageName getStorage()
        Returns the report storage item.
        Returns:
        the storage item

      • storageTipText

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

      • setMerge

        public void setMerge​(MergeReport.MergeType value)
        Sets the merge type.
        Parameters:
        value - the merge

      • mergeTipText

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

      • isUsingStorage

        public boolean isUsingStorage()
        Returns whether storage items are being used.
        Specified by:
        isUsingStorage in interface StorageUser
        Returns:
        true if storage items are used

      • findCallableActor

        protected Actor findCallableActor()
        Tries to find the callable actor referenced by its callable name.
        Returns:
        the callable actor or null if not found

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

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