Package adams.flow.transformer

Class ArrayToCollection

  • 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 ArrayToCollection
extends AbstractTransformer
implements ClassCrossReference
    Turns an array into a collection.

    See also:
    adams.flow.transformer.CollectionToArray

    Input/output:
    - accepts:
       adams.flow.core.Unknown[]
    - 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
    min-user-mode: Expert
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: ArrayToCollection
 
    -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
    min-user-mode: Expert
 
    -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
    min-user-mode: Expert
 
    -collection-class <adams.core.base.BaseClassname> (property: collectionClass)
    The class to use for the collection.
    default: java.util.ArrayList
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_CollectionClass

        protected BaseClassname m_CollectionClass
        the class for the array.

    • Constructor Detail

      • ArrayToCollection

        public ArrayToCollection()
        Default constructor.

      • ArrayToCollection

        public ArrayToCollection​(Class cls)
        Initializing with the specified class.
        Parameters:
        cls - the class to use

      • ArrayToCollection

        public ArrayToCollection​(BaseClassname cls)
        Initializing with the specified class.
        Parameters:
        cls - the class to use

    • Method Detail

      • setCollectionClass

        public void setCollectionClass​(BaseClassname value)
        Sets the class for the collection.
        Parameters:
        value - the classname

      • getCollectionClass

        public BaseClassname getCollectionClass()
        Returns the class for the collection.
        Returns:
        the classname

      • collectionClassTipText

        public String collectionClassTipText()
        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 classes that are accepted as input.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the classes

      • generates

        public Class[] generates()
        Returns the classes that are generated as output.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the classes

      • doExecute

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