Package adams.flow.source

Class StorageValue

  • 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 StorageValue
extends AbstractSimpleSource
implements StorageUser
    Outputs the value associated with the specified name from temporary storage.
    Does nothing if the storage value isn't present.
    By supplying a cache name, the value can be obtained from a LRU cache instead of the regular storage.

    Input/output:
    - 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: StorageValue
 
    -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
 
    -cache <java.lang.String> (property: cache)
    The name of the cache to retrieve 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 retrieve.
    default: storage
 
    -conversion <adams.data.conversion.Conversion> (property: conversion)
    The type of conversion to perform.
    default: adams.data.conversion.UnknownToUnknown
    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 stored value.

      • m_StoredValue

        protected Object m_StoredValue
        the stored value.

      • m_Conversion

        protected Conversion m_Conversion
        the type of conversion.

    • Constructor Detail

      • StorageValue

        public StorageValue()
        Default constructor.

      • StorageValue

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

      • StorageValue

        public StorageValue​(String storageName)
        Initializes with the specified storage name.
        Parameters:
        storageName - the name 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.

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

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

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