Package adams.flow.transformer

Class MergeReportFromMap

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUser, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class MergeReportFromMap
extends AbstractTransformer
implements StorageUser, ClassCrossReference, LenientModeSupporter
    Merges the passing through report handler/report objects with the referenced map of report objects in storage. The specified key field is used to determine the key (string) in the map.

    See also:
    adams.data.conversion.ReportArrayToMap

    Input/output:
    - accepts:
       adams.data.report.MutableReportHandler
       adams.data.report.Report
    - generates:
       adams.data.report.MutableReportHandler
       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: MergeReportFromMap
 
    -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
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the stored map containing the sample ID <-> sample data object
    mapping.
    default: storage
 
    -key <adams.data.report.Field> (property: key)
    The field to use as key in the map.
    default:
 
    -merge <REPLACE|MERGE_CURRENT_WITH_OTHER|MERGE_OTHER_WITH_CURRENT> (property: merge)
    Determines how to perform the merge.
    default: MERGE_CURRENT_WITH_OTHER
 
    -lenient <boolean> (property: lenient)
    If enabled, missing IDs in the map won't cause an error.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StorageName

        protected StorageName m_StorageName
        the name of the stored value.

      • m_Key

        protected Field m_Key
        the field to acts as key in the map.

      • m_Lenient

        protected boolean m_Lenient
        whether to be lenient.

    • Constructor Detail

      • MergeReportFromMap

        public MergeReportFromMap()

    • Method Detail

      • setStorageName

        public void setStorageName​(StorageName value)
        Sets the name of the stored map with the sample data objects.
        Parameters:
        value - the name

      • getStorageName

        public StorageName getStorageName()
        Returns the name of the stored map with the sample data objects.
        Returns:
        the name

      • storageNameTipText

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

      • setKey

        public void setKey​(Field value)
        Sets the field to use as key in the map.
        Parameters:
        value - the field

      • getKey

        public Field getKey()
        Returns the field in use as key in the map.
        Returns:
        the field

      • keyTipText

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

      • setLenient

        public void setLenient​(boolean value)
        Sets whether to use lenient mode (missing IDs in map won't cause error).
        Specified by:
        setLenient in interface LenientModeSupporter
        Parameters:
        value - true if to turn on lenient mode

      • getLenient

        public boolean getLenient()
        Returns whether to use lenient mode (missing IDs in map won't cause error).
        Specified by:
        getLenient in interface LenientModeSupporter
        Returns:
        true if lenient mode on

      • lenientTipText

        public String lenientTipText()
        Returns the tip text for this property.
        Specified by:
        lenientTipText in interface LenientModeSupporter
        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.
        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

      • isUsingStorage

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

      • doExecute

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