Package adams.flow.transformer

Class DeleteStorageValue

  • 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 DeleteStorageValue
extends AbstractTransformer
implements StorageUpdater
    Removes the specified value (or the ones that match the regular expression) 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
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: DeleteStorageValue
 
    -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
 
    -type <NAME|REGEXP> (property: type)
    How to determine the storage item(s) to delete.
    default: NAME
 
    -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> (property: storageName)
    The name of the stored value to delete.
    default: storage
 
    -regexp <adams.core.base.BaseRegExp> (property: regExp)
    The regular expression used for matching the storage items to delete.
    default: storage
    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_StorageName

        protected StorageName m_StorageName
        the name of the value to store.

      • m_RegExp

        protected BaseRegExp m_RegExp
        the regexp to match against variable names.

    • Constructor Detail

      • DeleteStorageValue

        public DeleteStorageValue()
        Default constructor.

      • DeleteStorageValue

        public DeleteStorageValue​(StorageName storageName)
        Initializes with the specified name.
        Parameters:
        storageName - the name to use

      • DeleteStorageValue

        public DeleteStorageValue​(String storageName)
        Initializes with the specified name.
        Parameters:
        storageName - the name to use

    • Method Detail

      • setType

        public void setType​(DeleteStorageValue.MatchingType value)
        Sets how to determine storage items to delete.
        Parameters:
        value - the matching type

      • typeTipText

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

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

      • setStorageName

        public void setStorageName​(String value)
        Sets the name of the stored value.
        Parameters:
        value - the name

      • setStorageName

        public void setStorageName​(StorageName value)
        Sets the name of the stored value.
        Parameters:
        value - the name

      • getStorageName

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

      • setRegExp

        public void setRegExp​(BaseRegExp value)
        Sets the regular expression to match the storage item names against.
        Parameters:
        value - the regular expression

      • getRegExp

        public BaseRegExp getRegExp()
        Returns the regular expression to match the storage item names against.
        Returns:
        the regular expression

      • regExpTipText

        public String regExpTipText()
        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