Package adams.flow.transformer

Class CollectionInsert

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class CollectionInsert
extends AbstractTransformer
implements ClassCrossReference
    Inserts an object in the collection using the specified position.
    The object can be retrieved from a callable actor or from storage.
    If the collection does not implement the java.util.List interface and the insertion is not at the end, the insertion will fail.

    See also:
    adams.flow.transformer.StorageCollectionInsert

    Input/output:
    - accepts:
       java.util.Collection
    - generates:
       java.util.Collection


    -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: CollectionInsert
 
    -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
 
    -retrieval-type <AUTO|SOURCE_ACTOR|STORAGE> (property: retrievalType)
    Determines how to retrieve the object, in case of AUTO, first the callable
    actor is checked and then the storage.
    default: AUTO
 
    -object-actor <adams.flow.core.CallableActorReference> (property: objectActor)
    The callable actor (source) to retrieve the object from, ignored if not
    present.
    default:
 
    -object-storage <adams.flow.control.StorageName> (property: objectStorage)
    The storage item to retrieve the object from, ignored if not present.
    default: storage
 
    -object-type <adams.core.base.BaseClassname> (property: objectType)
    The interface or superclass to restrict the object to.
    default: java.lang.Object
 
    -position <adams.core.Index> (property: position)
    The position where to insert the string.
    default: last
    example: An index is a number starting with 1; the following placeholders can be used as well: first, second, third, last_2, last_1, last
 
    -after <boolean> (property: after)
    If enabled, the string is inserted after the position instead of at the
    position.
    default: false
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Position

        protected Index m_Position
        the position where to insert the string.

      • m_After

        protected boolean m_After
        whether to insert after the position instead of at.

      • m_Retriever

        protected ObjectRetriever m_Retriever
        for retrieving the object.

    • Constructor Detail

      • CollectionInsert

        public CollectionInsert()

    • Method Detail

      • retrievalTypeTipText

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

      • setObjectActor

        public void setObjectActor​(CallableActorReference value)
        Sets the callable actor to retrieve the object from.
        Parameters:
        value - the actor reference

      • getObjectActor

        public CallableActorReference getObjectActor()
        Returns the callable actor to retrieve the object from.
        Returns:
        the actor reference

      • objectActorTipText

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

      • setObjectStorage

        public void setObjectStorage​(StorageName value)
        Sets the storage item name to get the object from.
        Parameters:
        value - the storage name

      • getObjectStorage

        public StorageName getObjectStorage()
        Returns the storage item name to get the object from.
        Returns:
        the storage name

      • objectStorageTipText

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

      • setObjectType

        public void setObjectType​(BaseClassname value)
        Sets the interface or superclass to restrict the objects to.
        Parameters:
        value - the class

      • getObjectType

        public BaseClassname getObjectType()
        Returns the interface or superclass to restrict the objects to.
        Returns:
        the class

      • objectTypeTipText

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

      • setPosition

        public void setPosition​(Index value)
        Sets the position where to insert the string.
        Parameters:
        value - the position

      • getPosition

        public Index getPosition()
        Returns the position where to insert the string.
        Returns:
        the position

      • positionTipText

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

      • setAfter

        public void setAfter​(boolean value)
        Sets whether to insert at or after the position.
        Parameters:
        value - true if to add after

      • getAfter

        public boolean getAfter()
        Returns whether to insert at or after the position.
        Returns:
        true if to add after

      • afterTipText

        public String afterTipText()
        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:
        the Class of objects that can be processed

      • generates

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

      • doExecute

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