Package adams.flow.source

Class CombineStorage

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class CombineStorage
extends AbstractSimpleSource
    Outputs the expanded string generated from the specified combination expression (variables and storage placeholders). In case of storage placeholders the string representation of the storage item is used.
    The expression string consists of arbitrary strings and the following special placeholders:
    - variables: @{...}
    - storage placeholders: %{...}


    Input/output:
    - generates:
       java.lang.String


    -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: CombineStorage
 
    -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
 
    -expression <adams.core.base.BaseText> (property: expression)
    The expression to use for combining the variables and storage placeholders.
    default: 
 
    -conversion <adams.data.conversion.Conversion> (property: conversion)
    The type of conversion to perform.
    default: adams.data.conversion.StringToString
    Version:
    $Revision: 9122 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Expression

        protected BaseText m_Expression
        the expression containing the variables/storage placeholders.

      • m_Conversion

        protected Conversion m_Conversion
        the type of conversion.

    • Constructor Detail

      • CombineStorage

        public CombineStorage()

    • Method Detail

      • setExpression

        public void setExpression​(BaseText value)
        Sets the expression for combining the variables/storage placeholders.
        Parameters:
        value - the expression

      • getExpression

        public BaseText getExpression()
        Returns the expression for combining the variables/storage placeholders.
        Returns:
        the expression

      • expressionTipText

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

      • setConversion

        public void setConversion​(Conversion value)
        Sets the type of conversion to perform.
        Parameters:
        value - the type of conversion

      • getConversion

        public Conversion getConversion()
        Returns the type of conversion to perform.
        Returns:
        the type of conversion

      • conversionTipText

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        java.lang.String.class

      • doExecute

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