Package adams.flow.transformer

Class AppendArchive

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, StorageUser, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class AppendArchive
extends AbstractTransformer
implements ClassCrossReference, StorageUser
    Appends the file or storage item to the archive passing through.

    See also:
    adams.flow.source.NewArchive
    adams.flow.sink.CloseArchive

    Input/output:
    - accepts:
       adams.core.io.ArchiveManager
    - generates:
       adams.core.io.ArchiveManager


    -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: AppendArchive
 
    -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
 
    -type <FILE|STORAGE> (property: type)
    The type of data to process.
    default: FILE
 
    -input-file <adams.core.io.PlaceholderFile> (property: inputFile)
    The file to process by the PDF processors.
    default: ${CWD}
 
    -storage-name <adams.flow.control.StorageName> (property: storageName)
    The name of the storage item to retrieve.
    default: storage
 
    -object-appender <adams.flow.transformer.appendarchive.ArchiveObjectAppender> (property: objectAppender)
    The scheme to use for adding the storage item object to the archive.
    default: adams.flow.transformer.appendarchive.SerializedObjectAppender
 
    -entry-name <java.lang.String> (property: entryName)
    The name to use in the archive; you can also specify sub-folders with 'SUBFOLDER
    /FILE.EXT' as the name
    default:
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Constructor Detail

      • AppendArchive

        public AppendArchive()

    • Method Detail

      • setType

        public void setType​(AppendArchive.DataType value)
        Sets the type of data to use.
        Parameters:
        value - the 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.

      • setInputFile

        public void setInputFile​(PlaceholderFile value)
        Sets the input file to process.
        Parameters:
        value - the file

      • getInputFile

        public PlaceholderFile getInputFile()
        Returns the input file to process.
        Returns:
        the file

      • inputFileTipText

        public String inputFileTipText()
        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 storage item to retrieve.
        Parameters:
        value - the storage item

      • getStorageName

        public StorageName getStorageName()
        Returns the name of the storage item to retrieve.
        Returns:
        the storage item

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

      • setObjectAppender

        public void setObjectAppender​(ArchiveObjectAppender value)
        Sets the appender scheme for adding the object to the archive.
        Parameters:
        value - the appender

      • getObjectAppender

        public ArchiveObjectAppender getObjectAppender()
        Returns the appender scheme for adding the object to the archive.
        Returns:
        the appender

      • objectAppenderTipText

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

      • setEntryName

        public void setEntryName​(String value)
        Sets the name to use in the archive.
        Parameters:
        value - the name

      • getEntryName

        public String getEntryName()
        Returns the name to use in the archive.
        Returns:
        the name

      • entryNameTipText

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

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • doExecute

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