Package adams.flow.source

Class NewList

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class NewList
extends AbstractSimpleSource
    Generates a list string based on the items produced by the generator and the specified separator.

    Input/output:
    - 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: NewList
 
    -annotation <adams.core.base.BaseText> (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
 
    -generator <adams.flow.source.newlist.AbstractListGenerator> (property: generator)
    The list generator to use.
    default: adams.flow.source.newlist.FixedList
 
    -separator <java.lang.String> (property: separator)
    The separator to use between the list elements.
    default: ,
 
    -quote-type <NONE|SINGLE|DOUBLE> (property: quoteType)
    The type of quote to use.
    default: NONE
    Version:
    $Revision: 7828 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Separator

        protected String m_Separator
        the separator for the list items.

    • Constructor Detail

      • NewList

        public NewList()

    • Method Detail

      • setGenerator

        public void setGenerator​(AbstractListGenerator value)
        Sets the generator to use.
        Parameters:
        value - the generator

      • getGenerator

        public AbstractListGenerator getGenerator()
        Returns the generator to use.
        Returns:
        the generator

      • generatorTipText

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

      • setSeparator

        public void setSeparator​(String value)
        Sets the list element separator to use.
        Parameters:
        value - the separator

      • getSeparator

        public String getSeparator()
        Returns the list element separator to use.
        Returns:
        the separator

      • separatorTipText

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

      • setQuoteType

        public void setQuoteType​(NewList.QuoteType value)
        Sets the type of quote to use.
        Parameters:
        value - the type

      • getQuoteType

        public NewList.QuoteType getQuoteType()
        Returns the type of quote to use.
        Returns:
        the type

      • quoteTypeTipText

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

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        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