com.highqsoft.moma.impl

Class Zip

java.lang.Object

com.highqsoft.xsd.AbstractImplementation

com.highqsoft.moma.impl.Zip

All Implemented Interfaces:

ExecutableIF, ImplementationIF

public class Zip
extends AbstractImplementation
implements ExecutableIF

\page Impl \section implementation_com_highqsoft_moma_impl_Zip Zip \addindex Zip The Zip Implementation can be used to: - compress files and directories into a zip file, - expand zip files The rule belongs to the package com.highqsoft.moma.impl \subsection ZipProperties Properties \addindex Zip Properties The Zip is initzialized with the following properties: Hint: From considerate to existing jobs, the attributes (mandatory) are not necessarily checked in the rule! \subsection Compress files or directories \li \b CompressFrom (mandatory, no default)
If this property is set the implementation operates in mode "compress". If the configured path is not absolute it is expected to be relative to ZipFile. \li \b ZipFile (optional, default: CompressFrom + ".zip" )
The name of the zip file to create. If this property is not set the name of the zip file is derived from CompressFrom by adding the extension \e .zip. \li \b OverwriteTarget (optional, default \e false)
If this property is true an already existing zip file is deleted. \li \b DeleteSource (optional, default \e false)
If this property is true the source directory is deleted after the zip file is created. \li \b Encoding (optional, default \e ISO-8859-1)
Defines the encoding of the zip file. This is important if the filenames or the content of the files contain non ascii characters. \li \b Recursiv (optional, default \e false)
Defines if the action is performed recursively on sub directories or not. \li \b CompressionLevel (optional, default \e 5)
Defines the level of compression. \li \b IgnoreIfNotExist (optional, default \e false)
If CompressFrom does not exist and this property is set true, nothing is done inside this rule. If this property is false and CompressFrom does not exist an exception is thrown. \subsection Uncompress file \li \b ExpandTo (mandatory, no default)
If this property is set the implementation operates in mode "uncompress". If the configured path is not absolute it is expected to be relative to ZipFile. \li \b ZipFile (mandatory, no default)
The name of the zip file to extract from. \li \b OverwriteTarget (optional, default \e false)
If this property is true, the path configured with \e ExpandTo is deleted before the zip file is expanded. \li \b DeleteSource (optional, default \e false)
If this property is true the zip file is deleted after it is expanded. \li \b ProcessedFilesRef (optional, no default)
If this property is set the names of all files processed are stored in the context. The implementation creates a reference in the context that holds a String[] containing the file names and a property with the same name containing the filenames as a list of names separated with semicolon. Caution: When no files extracet, the reference contains null and the property is not set! \li \b Searchpattern (optional, default: *)
This property can contain a list of filenames separated by a semicolon. When this property is given, only files matching the passed list are extracted. \li \b IgnoreIfNotExist (optional, default \e false)
If ZipFile does not exist and this property is set true, nothing is done inside this rule. If this property is false and ZipFile does not exist an exception is thrown. \subsection ZipExample Example \addindex Zip Example The example below is called from the sequence in a modelmapper control file. It extracts all atf files from ${Arg.Filename} to ${Setup.TempDirectory} and stores the names of all files found in the property \e AtfFileName as a String and in a reference with the same name as an array of Strings. \code \endcode \subsection ZipMomaMethods Methods used within the Modelmapper \addindex Zip Modelmapper Methods \li void execute()
Perform the required action.

Field Summary

Fields inherited from class com.highqsoft.xsd.AbstractImplementation

arguments, ctx, descriptor, NEW_LINE

Constructor Summary

Constructors

Constructor and Description
Zip()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute() Performs the requests, set during initialize.
void	extractArchive(java.io.File archive, java.io.File destDir)
void	init() Verifies input and initializes local variables.
void	terminate() Terminate the execution.

Methods inherited from class com.highqsoft.xsd.AbstractImplementation

addAttributesToNameValueUnitArray, addAttributeToNameValueUnitArray, addStringValueToNameValueUnitArray, checkDirectoy, checkDirectoy, checkDirectoy, checkFile, checkFile, checkFile, checkIntValue, checkStringValue, compressNvuArray, createMessageFromPropertyFile, createMessageFromPropertyFile, createMessageFromPropertyFile, createTsUnionFromObject, deleteRowWithAttributes, getArguments, getContext, getDescriptor, getListFromProperty, getMandatoryProperty, getMandatoryProperty, getMandatoryPropertyAsInt, getMandatoryPropertyAsList, getMandatoryPropertyWithRuleException, getNvuArrayFromMap, getNvuArrayFromMap, getNvuObjectWithName, getNvuObjectWithName, getNvuObjectWithName, getOdsCacheFromProperty, getOptioanlPropertyAsInt, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalProperty, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsBoolean, getOptionalPropertyAsList, makeUpperCaseKeyword, removeAttributeFromNameValueUnitArray, removeAttributeFromNameValueUnitArray, setArguments, setContext, setDescriptor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, setArguments, setContext, setDescriptor

Constructor Detail

Zip

public Zip()

Method Detail

init

public void init()
          throws InitializationFailedException

Verifies input and initializes local variables.

Reads the arguments, if ommited, assings default values if defined, and converts them into the internal representation. Depending on the argument combination some ommited arguments are derived from others.

If either mandatory arguments are ommited, or arguments are semanticallly or syntactically wrong, an excetion is thrown.

Specified by:

init in interface ImplementationIF

Specified by:

init in class AbstractImplementation

Throws:

InitializationFailedException - if arguments are wrong, invalid combined or missing.

See Also:

COMPRESSFROM, COMPRESSIONLEVEL, DELETESOURCE, ENCODING, EXPANDTO, OVERWRITE, RECURSIVE, SEARCHPATTERN, ZIPFILE

execute

public void execute()
             throws ExecutableException

Performs the requests, set during initialize.

Specified by:

execute in interface ExecutableIF

Throws:

ExecutableException - if an internal error occurs.

terminate

public void terminate()
               throws TerminationException

Description copied from interface: ExecutableIF

Terminate the execution.

Specified by:

terminate in interface ExecutableIF

Throws:

TerminationException - If error occureed.

extractArchive

public void extractArchive(java.io.File archive,
                  java.io.File destDir)
                    throws java.io.IOException,
                           ExecutableException

Parameters:

archive - File zipfile.

destDir - File directory.

Throws:

java.io.IOException - If problems with I/O.

ExecutableException