Package adams.flow.source

Class HashSet

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUser, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class HashSet
extends AbstractSimpleSource
implements StorageUser
    Outputs the specified hashset as spreadsheet, with one column called 'Value' by default.

    Input/output:
    - generates:
       adams.data.spreadsheet.SpreadSheet


    -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: HashSet
 
    -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
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the hashset in internal storage.
    default: hashset
 
    -conversion <adams.data.conversion.Conversion> (property: conversion)
    The type of conversion to perform.
    default: adams.data.conversion.AnyToString
 
    -column-name <java.lang.String> (property: columnName)
    The name of the column in the generated spreadsheet.
    default: Value
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • COLUMN_VALUE

        public static final String COLUMN_VALUE
        the single column of the spreadsheet containing the hashset elements.
        See Also:
        Constant Field Values

      • m_StorageName

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

      • m_Conversion

        protected Conversion m_Conversion
        the type of conversion.

      • m_ColumnName

        protected String m_ColumnName
        the column name to use.

    • Constructor Detail

      • HashSet

        public HashSet()

    • Method Detail

      • setStorageName

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

      • getStorageName

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

      • 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.

      • setColumnName

        public void setColumnName​(String value)
        Sets the name of the column in the generated spreadsheet.
        Parameters:
        value - the name

      • getColumnName

        public String getColumnName()
        Returns the name of the column in the generated spreadsheet.
        Returns:
        the name

      • columnNameTipText

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

      • isUsingStorage

        public boolean isUsingStorage()
        Returns whether storage items are being used.
        Specified by:
        isUsingStorage in interface StorageUser
        Returns:
        true if storage items are used

      • 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