org.cip4.lib.xjdf.xml.internal

Class AbstractXmlPackager

java.lang.Object

org.cip4.lib.xjdf.xml.internal.AbstractXmlPackager

Direct Known Subclasses:

XJdfPackager

public abstract class AbstractXmlPackager
extends Object

Packaging logic for XML Documents. Package an XML with all references in a ZIP Package.

Author:

stefan.meissner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractXmlPackager.CompressionLevel ZIP Compression Level

Constructor Summary

Constructors

Constructor and Description
AbstractXmlPackager(byte[] xmlDoc, String rootPath) Custom constructor.
AbstractXmlPackager(String xmlPath) Custom constructor.

Method Summary

Methods

Modifier and Type	Method and Description
AbstractXmlPackager.CompressionLevel	getCompressionLevel() Getter for compressionLevel attribute.
protected byte[]	getXmlDoc() Getter for xmlDoc attribute.
protected void	packageXml(OutputStream os, String docName) Packages an XJDF Document to a zipped binary output stream.
protected File	registerFile(String srcPath, String targetDir)
protected void	registerFiles(String xPathAttribute, String targetDir) Check all attributes, defined by an xpath expression, for file URLs and update and register in fileMap.
void	setCompressionLevel(AbstractXmlPackager.CompressionLevel compressionLevel) Setter for compressionLevel attribute.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractXmlPackager

public AbstractXmlPackager(String xmlPath)
                    throws Exception

Custom constructor. Accepting an XJDF Path for initializing.

Parameters:

xmlPath - Path to XJDF Document.

Throws:

Exception

AbstractXmlPackager

public AbstractXmlPackager(byte[] xmlDoc,
                   String rootPath)
                    throws Exception

Custom constructor. Accepting an XML Document for initializing.

Parameters:

xmlDoc - XML Document for parsing and packaging.

rootPath - Root path of the files.

Throws:

Exception

Method Detail

getXmlDoc

protected byte[] getXmlDoc()

Getter for xmlDoc attribute.

Returns:

the xmlDoc

getCompressionLevel

public AbstractXmlPackager.CompressionLevel getCompressionLevel()

Getter for compressionLevel attribute.

Returns:

the compressionLevel

setCompressionLevel

public void setCompressionLevel(AbstractXmlPackager.CompressionLevel compressionLevel)

Setter for compressionLevel attribute.

Parameters:

compressionLevel - the compressionLevel to set

packageXml

protected void packageXml(OutputStream os,
              String docName)
                   throws Exception

Packages an XJDF Document to a zipped binary output stream.

Parameters:

os - Target OutputStream where XJdfDocument is being packaged.

Throws:

Exception

registerFiles

protected void registerFiles(String xPathAttribute,
                 String targetDir)
                      throws PackagerException

Check all attributes, defined by an xpath expression, for file URLs and update and register in fileMap.

Parameters:

xPathAttribute - XPath expression which defins a set of Attributes in XJDF Document.

Throws:

PackagerException - if files can not be read from the xJdf.

registerFile

protected File registerFile(String srcPath,
                String targetDir)
                     throws PackagerException

Throws:

PackagerException