Package adams.flow.standalone

Class HashSetInit

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUpdater, Actor, ErrorHandler, Serializable, Comparable
    public class HashSetInit
extends AbstractStandalone
implements StorageUpdater, ClassCrossReference
    Creates an empty hashset in internal storage under the specified name.
    Initial string values can be supplied as well, which can be transformed using the specified conversion.

    See also:
    adams.flow.transformer.HashSetInit
    adams.flow.transformer.HashSetAdd
    adams.flow.source.HashSet
    adams.flow.condition.bool.HashSet 

    -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: HashSetInit
 
    -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
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the hashset in the internal storage.
    default: hashset
 
    -initial <adams.core.base.BaseString> [-initial ...] (property: initial)
    The (optional) initial strings to populate the hashset with.
    default:
 
    -conversion <adams.data.conversion.Conversion> (property: conversion)
    The type of conversion to perform.
    default: adams.data.conversion.StringToString
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StorageName

        protected StorageName m_StorageName
        the name of the hashset in the internal storage.

      • m_Initial

        protected BaseString[] m_Initial
        the initial strings to populate the hashset with.

      • m_Conversion

        protected Conversion m_Conversion
        the type of conversion.

    • Constructor Detail

      • HashSetInit

        public HashSetInit()

    • Method Detail

      • isUpdatingStorage

        public boolean isUpdatingStorage()
        Returns whether storage items are being updated.
        Specified by:
        isUpdatingStorage in interface StorageUpdater
        Returns:
        true if storage items are updated

      • setStorageName

        public void setStorageName​(StorageName value)
        Sets the name for the hashset in the internal storage.
        Parameters:
        value - the name

      • getStorageName

        public StorageName getStorageName()
        Returns the name for the hashset in the internal storage.
        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.

      • setInitial

        public void setInitial​(BaseString[] value)
        Sets the (optional) initial values to populate the hashset with.
        Parameters:
        value - the values

      • getInitial

        public BaseString[] getInitial()
        Returns the (optional) initial values to populate the hashset with.
        Returns:
        the values

      • initialTipText

        public String initialTipText()
        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​(Conversion value)
        Sets the type of conversion to perform.
        Parameters:
        value - the type of conversion

      • getConversion

        public Conversion getConversion()
        Returns the type of conversion to perform.
        Returns:
        the type of 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.

      • doExecute

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