Package adams.flow.standalone

Class InitPublishSubscribe

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUpdater, Actor, ErrorHandler, Serializable, Comparable
    public class InitPublishSubscribe
extends AbstractStandalone
implements StorageUpdater
    Initializes a publish/subscribe data structure in internal storage. 

    -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: InitPublishSubscribe
 
    -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> [-storage-name ...] (property: storageNames)
    The name(s) of the publish/subscribe data structure(s) in the internal storage.
    default: pubsub
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_StorageNames

        protected StorageName[] m_StorageNames
        the names of the publish/subscribe data structures in the internal storage.

    • Constructor Detail

      • InitPublishSubscribe

        public InitPublishSubscribe()

    • Method Detail

      • setStorageNames

        public void setStorageNames​(StorageName[] value)
        Sets the names for the pub/sub data structures in the internal storage.
        Parameters:
        value - the names

      • getStorageNames

        public StorageName[] getStorageNames()
        Returns the names for the pub/sub data structures in the internal storage.
        Returns:
        the names

      • storageNamesTipText

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

      • isUpdatingStorage

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

      • doExecute

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