Package adams.flow.transformer

Class SimpleStringReplace

  • 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 SimpleStringReplace
extends AbstractStringOperation
    Performs a string replacement, using String.replace(.., ...).
    If the 'replace' string contains both, variables and placeholders, then first all variables are expanded and then the placeholders.

    Input/output:
    - accepts:
       java.lang.String
       java.lang.String[]
    - generates:
       java.lang.String
       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: SimpleStringReplace
 
    -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
 
    -find <java.lang.String> (property: find)
    The sub-string to find.
    default: find
 
    -replace <java.lang.String> (property: replace)
    The string to replace the occurrences with.
    default:
 
    -placeholder <boolean> (property: replaceContainsPlaceholder)
    Set this to true to enable automatic placeholder expansion for the replacement
    string.
    default: false
 
    -variable <boolean> (property: replaceContainsVariable)
    Set this to true to enable automatic variable expansion for the replacement
    string.
    default: false
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Find

        protected String m_Find
        the string to find.

      • m_Replace

        protected String m_Replace
        the replacement string.

      • m_ReplaceContainsPlaceholder

        protected boolean m_ReplaceContainsPlaceholder
        whether the replace string contains a placeholder, which needs to be expanded first.

      • m_ReplaceContainsVariable

        protected boolean m_ReplaceContainsVariable
        whether the replace string contains a variable, which needs to be expanded first.

    • Constructor Detail

      • SimpleStringReplace

        public SimpleStringReplace()

    • Method Detail

      • setFind

        public void setFind​(String value)
        Sets the string to find.
        Parameters:
        value - the string

      • getFind

        public String getFind()
        Returns the string to find.
        Returns:
        the string

      • findTipText

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

      • setReplace

        public void setReplace​(String value)
        Sets the string to replace the occurrences with.
        Parameters:
        value - the string

      • getReplace

        public String getReplace()
        Returns the string to replace the occurences with.
        Returns:
        the string

      • replaceTipText

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

      • setReplaceContainsPlaceholder

        public void setReplaceContainsPlaceholder​(boolean value)
        Sets whether the replace string contains a placeholder which needs to be expanded first.
        Parameters:
        value - true if replace string contains a placeholder

      • getReplaceContainsPlaceholder

        public boolean getReplaceContainsPlaceholder()
        Returns whether the replace string contains a placeholder which needs to be expanded first.
        Returns:
        true if replace string contains a placeholder

      • replaceContainsPlaceholderTipText

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

      • setReplaceContainsVariable

        public void setReplaceContainsVariable​(boolean value)
        Sets whether the replace string contains a variable which needs to be expanded first.
        Parameters:
        value - true if replace string contains a variable

      • getReplaceContainsVariable

        public boolean getReplaceContainsVariable()
        Returns whether the replace string contains a variable which needs to be expanded first.
        Returns:
        true if replace string contains a variable

      • replaceContainsVariableTipText

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

      • process

        protected String process​(String s,
                         int index)
        Processes the string.
        Specified by:
        process in class AbstractStringOperation
        Parameters:
        s - the string to process
        index - the 0-based index of the string currently being processed
        Returns:
        the processed string or null if nothing produced