Package adams.flow.transformer

Class ContainerToStorage

  • 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 ContainerToStorage
extends AbstractContainerValueExtractor
    Extracts the specified values from the container passing through and makes them available as storage items. A prefix for the storage names can be supplied.

    Input/output:
    - accepts:
       adams.flow.container.AbstractContainer
    - generates:
       adams.flow.container.AbstractContainer


    Container information:
    - adams.flow.container.AbstractContainer: 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ContainerToStorage
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression to match the names of the container values against.
    default: .*
    more: https://docs.oracle.com/javase/tutorial/essential/regex/
    https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html
 
    -prefix <java.lang.String> (property: prefix)
    The prefix to use for the storage names.
    default:
 
    -container-storage-name-pair <adams.core.base.BaseKeyValuePair> [-container-storage-name-pair ...] (property: containerStorageNamePairs)
    The pairs of container name and storage name, overrides the regular expression.
    default:
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ContainerStorageNamePairs

        protected List<BaseKeyValuePair> m_ContainerStorageNamePairs
        the container name/storage name pairs.

    • Constructor Detail

      • ContainerToStorage

        public ContainerToStorage()

    • Method Detail

      • prefixTipText

        public String prefixTipText()
        Returns the tip text for this property.
        Specified by:
        prefixTipText in class AbstractContainerValueExtractor
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • addContainerStorageNamePair

        public void addContainerStorageNamePair​(BaseKeyValuePair value)
        Adds the container name / storage name pair.
        Parameters:
        value - the pair to add

      • setContainerStorageNamePairs

        public void setContainerStorageNamePairs​(BaseKeyValuePair[] value)
        Sets the container name / storage name pairs.
        Parameters:
        value - the pairs

      • getContainerStorageNamePairs

        public BaseKeyValuePair[] getContainerStorageNamePairs()
        Returns the pairs of container name / storage name.
        Returns:
        the pairs

      • containerStorageNamePairsTipText

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