Package adams.flow.standalone

Class DeserializeToStorage

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, ModelFileHandler, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUpdater, Actor, ErrorHandler, Serializable, Comparable
    public class DeserializeToStorage
extends AbstractStandalone
implements ModelFileHandler, StorageUpdater
    Deserializes a model from a file with the specified object reader and stores it directly in storage.
    It is also possible to define multiple storage name / file name pairs, to make the deserialization of large amounts of files more efficient. Storage name and/or file name can be variables as well (@{...}) 

    -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: DeserializeToStorage
 
    -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
 
    -model-file <adams.core.io.PlaceholderFile> (property: modelFile)
    The file to deserialize and put into storage.
    default: ${CWD}
 
    -reader <adams.data.io.input.AbstractObjectReader> (property: reader)
    The reader to use for loading the model.
    default: adams.data.io.input.SerializedObjectReader
 
    -cache <java.lang.String> (property: cache)
    The name of the cache to store the value in; uses the regular storage if
    left empty.
    default:
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name to store the model under.
    default: storage
 
    -storage-file-pair <adams.core.base.BaseKeyValuePair> [-storage-file-pair ...] (property: storageFilePairs)
    The pairs of storage name and file name.
    default:
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_ModelFile

        protected PlaceholderFile m_ModelFile
        the file to deserialize.

      • m_Cache

        protected String m_Cache
        the name of the LRU cache.

      • m_StorageName

        protected StorageName m_StorageName
        the storage name to store the model under.

    • Constructor Detail

      • DeserializeToStorage

        public DeserializeToStorage()

    • Method Detail

      • modelFileTipText

        public String modelFileTipText()
        Returns the tip text for this property.
        Specified by:
        modelFileTipText in interface ModelFileHandler
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setReader

        public void setReader​(AbstractObjectReader value)
        Sets the reader to use for loading the model.
        Parameters:
        value - the reader

      • getReader

        public AbstractObjectReader getReader()
        Returns the reader to use for loading the model.
        Returns:
        the reader

      • readerTipText

        public String readerTipText()
        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​(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.

      • addStorageFilePair

        public void addStorageFilePair​(BaseKeyValuePair value)
        Adds the variable name/value pair.
        Parameters:
        value - the pair to add

      • setStorageFilePairs

        public void setStorageFilePairs​(BaseKeyValuePair[] value)
        Sets the storage name / file name pairs.
        Parameters:
        value - the pairs

      • getStorageFilePairs

        public BaseKeyValuePair[] getStorageFilePairs()
        Returns the pairs of storage name / file name.
        Returns:
        the pairs

      • storageFilePairsTipText

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

      • read

        protected String read​(PlaceholderFile file,
                      StorageName name)
        Reads the file and stores the object in storage.
        Parameters:
        file - the file to read
        name - the storage name to use
        Returns:
        null if successful, otherwise error message

      • doExecute

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