Package adams.flow.transformer

Class StringArraySplit

  • All Implemented Interfaces:
    AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class StringArraySplit
extends AbstractArrayProvider
    Uses a regular expression to identify the string that triggers one or more splits in a string array, resulting in smaller arrays being output.
    What is done with the string triggering the split, is defined in the split handling option, e.g., discard it.
    Useful actor for splitting a log file into individual entry chunks.

    Input/output:
    - accepts:
       java.lang.String[]
    - 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: StringArraySplit
 
    -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
 
    -output-array <boolean> (property: outputArray)
    If enabled, the generate sub-arrays are output as an array rather than one-by-one.
    default: false
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression used for matching the strings.
    default: .*
 
    -split-handling <DISCARD|AT_START|AT_END> (property: splitHandling)
    Determines how the string is handled that triggered a split; DISCARD: string
    gets discarded; AT_START: is added at the start of the new output array;
    AT_END: is added at the end of the previous output array
    default: DISCARD
 
    -remainder-handling <DISCARD|OUTPUT> (property: remainderHandling)
    Determines how the handle any left over strings after the last split.
    default: OUTPUT
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • StringArraySplit

        public StringArraySplit()

    • Method Detail

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expression to match the strings against.
        Parameters:
        value - the regular expression

      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expression to match the strings against.
        Returns:
        the regular expression

      • regExpTipText

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

      • setSplitHandling

        public void setSplitHandling​(StringArraySplit.SplitHandling value)
        Sets how to handle the string that triggered the split.
        Parameters:
        value - the handling

      • getSplitHandling

        public StringArraySplit.SplitHandling getSplitHandling()
        Returns how to handle the string that triggered the split.
        Returns:
        the handling

      • splitHandlingTipText

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

      • setRemainderHandling

        public void setRemainderHandling​(StringArraySplit.RemainderHandling value)
        Sets how to handle any remaining strings after the last split.
        Parameters:
        value - the handling

      • getRemainderHandling

        public StringArraySplit.RemainderHandling getRemainderHandling()
        Returns how to handle any remaining strings after the last split.
        Returns:
        the handling

      • remainderHandlingTipText

        public String remainderHandlingTipText()
        Returns the tip text for this property.
        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.
        Returns:
        the Class of objects that can be processed

      • doExecute

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