Package adams.flow.source

Class NewArchive

  • All Implemented Interfaces:
    AdditionalInformationHandler, ClassCrossReference, CleanUpHandler, CrossReference, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, OutputProducer, Serializable, Comparable
    public class NewArchive
extends AbstractSimpleSource
implements ClassCrossReference
    Initializes the archive and forwards the data structure.

    See also:
    adams.flow.transformer.AppendArchive
    adams.flow.sink.CloseArchive

    Input/output:
    - 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: NewArchive
 
    -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
 
    -manager <adams.core.io.ArchiveManager> (property: manager)
    The manager to use for creating the compressed archive.
    default: adams.core.io.ZipArchiveManager
 
    -output <adams.core.io.PlaceholderFile> (property: output)
    The file for the archive manager to create.
    default: ${CWD}
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Manager

        protected ArchiveManager m_Manager
        the archive manager to use.

      • m_Output

        protected PlaceholderFile m_Output
        the filename of the archive output.

    • Constructor Detail

      • NewArchive

        public NewArchive()

    • Method Detail

      • setManager

        public void setManager​(ArchiveManager value)
        Sets the archive manager to use.
        Parameters:
        value - the manager

      • getManager

        public ArchiveManager getManager()
        Returns the current archive manager in use.
        Returns:
        the size in bytes

      • managerTipText

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

      • setOutput

        public void setOutput​(PlaceholderFile value)
        Sets the archive output filename.
        Parameters:
        value - the filename

      • getOutput

        public PlaceholderFile getOutput()
        Returns the archive output filename.
        Returns:
        the filename

      • outputTipText

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

      • 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