Package adams.flow.transformer

Class DeleteManyStorageValues

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUpdater, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class DeleteManyStorageValues
extends AbstractTransformer
implements StorageUpdater
    Removes the specified values from temporary storage whenever a token passes through.
    By supplying a cache name, the value can be removed from a LRU cache instead of the regular storage.

    Input/output:
    - accepts:
       adams.flow.core.Unknown
    - generates:
       adams.flow.core.Unknown


    -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: DeleteManyStorageValues
 
    -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
 
    -cache <java.lang.String> (property: cache)
    The name of the cache to remove the value from; uses the regular storage
    if left empty.
    default:
 
    -storage-name <adams.flow.control.StorageName> [-storage-name ...] (property: storageNames)
    The names of the stored values to delete.
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Cache

        protected String m_Cache
        the name of the LRU cache.

      • m_StorageNames

        protected List<StorageName> m_StorageNames
        the names of the value to delete.

    • Constructor Detail

      • DeleteManyStorageValues

        public DeleteManyStorageValues()
        Default constructor.

      • DeleteManyStorageValues

        public DeleteManyStorageValues​(StorageName[] storageNames)
        Initializes with the specified names.
        Parameters:
        storageNames - the name to use

      • DeleteManyStorageValues

        public DeleteManyStorageValues​(String[] storageNames)
        Initializes with the specified names.
        Parameters:
        storageNames - the names to use

    • Method Detail

      • setCache

        public void setCache​(String value)
        Sets the name of the LRU cache to use, regular storage if left empty.
        Parameters:
        value - the cache

      • getCache

        public String getCache()
        Returns the name of the LRU cache to use, regular storage if left empty.
        Returns:
        the cache

      • cacheTipText

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

      • addStorageName

        public void addStorageName​(String value)
        Adds the specified storage name.
        Parameters:
        value - the name to add

      • addStorageName

        public void addStorageName​(StorageName value)
        Adds the specified storage name.
        Parameters:
        value - the name to add

      • setStorageNames

        public void setStorageNames​(String[] value)
        Sets the names of the stored values.
        Parameters:
        value - the names

      • setStorageNames

        public void setStorageNames​(StorageName[] value)
        Sets the names of the stored values.
        Parameters:
        value - the names

      • getStorageNames

        public StorageName[] getStorageNames()
        Returns the names of the stored values.
        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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        adams.flow.core.Unknown.class

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        adams.flow.core.Unknown.class

      • doExecute

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