Package adams.flow.transformer

Class UnZIP

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable
    public class UnZIP
extends AbstractMultiDecompress
    Unzips a ZIP archive and broadcasts the full file names of the extracted files. A regular expression can be used to control the files that are being extracted. Whether the directory structure in the ZIP archive gets restored is optional.

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
    - generates:
       java.lang.String[]


    Valid options are: 

    -D (property: debug)
    If set to true, scheme may output additional info to the console.
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: UnZIP
 
    -annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
 
    -out-dir <adams.core.io.PlaceholderFile> (property: outputDir)
    The output directory to use.
    default: .
 
    -reg-exp <java.lang.String> (property: regExp)
    The regular expression that the file names must match in order to be extracted.
    default: .*
 
    -invert (property: invertMatching)
    If set to true, the matching sense of the regular expression is inverted.
 
    -create-dirs (property: createDirectories)
    If set to true, the directory structure stored in the ZIP archive will be
    restored.
 
    -buffer <int> (property: bufferSize)
    The size of the buffer in bytes for the data stream.
    default: 1024
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form