Package adams.flow.control

Class Injector

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ControlActor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class Injector
extends AbstractTransformer
implements ControlActor
    Injects a string token into the token sequence.
    The string can be inject before or after the current token. One can also control how often the string gets injected, i.e., every n-th token.

    Input/output:
    - accepts:
       java.lang.Object
    - generates:
       java.lang.Object


    -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: Injector
 
    -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 gets stopped in case this actor encounters an error;
     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
 
    -type <STRING|STORAGE> (property: type)
    The type of data to inject.
    default: STRING
 
    -location <BEFORE|AFTER|INPLACE> (property: location)
    The location where to inject the data.
    default: AFTER
 
    -injection <java.lang.String> (property: injection)
    The string to inject into the sequence; tab and newline can be inserted 
    as escaped sequence: \t and \n
    default: inject_me
 
    -conversion <adams.data.conversion.ConversionFromString> (property: conversion)
    The conversion to apply to the string before injecting it.
    default: adams.data.conversion.StringToString
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the storage item to inject.
    default: storage
 
    -nth <int> (property: everyNth)
    The number of tokens after which the injection takes place.
    default: 1
    minimum: 1
    Version:
    $Revision$
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • BACKUP_COUNTER

        public static final String BACKUP_COUNTER
        the key for storing the current counter in the backup.
        See Also:
        Constant Field Values

      • m_Injection

        protected String m_Injection
        the string to inject.

      • m_EveryNth

        protected int m_EveryNth
        every nth token the string will get injected.

      • m_Conversion

        protected ConversionFromString m_Conversion
        the conversion for turning the string into another object type.

      • m_StorageName

        protected StorageName m_StorageName
        the storage item.

      • m_Queue

        protected List m_Queue
        the strings to output.

      • m_Counter

        protected int m_Counter
        the token counter.

    • Constructor Detail

      • Injector

        public Injector()

    • Method Detail

      • setType

        public void setType​(Injector.DataType value)
        Sets the type of data to inject.
        Parameters:
        value - the type

      • getType

        public Injector.DataType getType()
        Returns the type of data to inject.
        Returns:
        the type

      • typeTipText

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

      • setLocation

        public void setLocation​(Injector.Location value)
        Sets the location where to inject the data.
        Parameters:
        value - the location

      • getLocation

        public Injector.Location getLocation()
        Returns the location where to inject the data.
        Returns:
        the location

      • locationTipText

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

      • setInjection

        public void setInjection​(String value)
        Sets the string to inject.
        Parameters:
        value - the string

      • getInjection

        public String getInjection()
        Returns the string to inject.
        Returns:
        the string

      • injectionTipText

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

      • setStorageName

        public void setStorageName​(StorageName value)
        Sets the name of the storage item to inject.
        Parameters:
        value - the name

      • getStorageName

        public StorageName getStorageName()
        Returns the name of the storage item to inject.
        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.

      • setEveryNth

        public void setEveryNth​(int value)
        Sets after how many tokens the injection takes place.
        Parameters:
        value - the number of tokens

      • getEveryNth

        public int getEveryNth()
        Returns after how many tokens the injection takes place.
        Returns:
        the number of tokens

      • everyNthTipText

        public String everyNthTipText()
        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​(ConversionFromString value)
        Sets the conversion to apply to the string.
        Parameters:
        value - the conversion

      • getConversion

        public ConversionFromString getConversion()
        Returns the conversion to apply to the string.
        Returns:
        the 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.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        java.lang.Object.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        java.lang.Object.class

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor

      • doExecute

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