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.

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(OutputStream out) Create a new AbstractXmlPackager.
AbstractXmlPackager(OutputStream out, boolean withoutHierarchy) Create a new AbstractXmlPackager.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	packageXml(XmlNavigator xmlNavigator, String docName, URI rootUri) Packages an XML document to a zipped binary output stream.
abstract void	packageXml(XmlNavigator xmlNavigator, URI rootUri) Packages an XML Document to a zipped binary output stream.
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(OutputStream out)

Create a new AbstractXmlPackager.

Parameters:

out - The underlying OutputStream to write the package to.

AbstractXmlPackager

public AbstractXmlPackager(OutputStream out,
                   boolean withoutHierarchy)

Create a new AbstractXmlPackager.

Parameters:

out - The underlying OutputStream to write the package to.

withoutHierarchy - Put all files into the zip root.

Method Detail

setCompressionLevel

public final void setCompressionLevel(AbstractXmlPackager.CompressionLevel compressionLevel)

Setter for compressionLevel attribute.

Parameters:

compressionLevel - the compressionLevel to set

packageXml

public abstract void packageXml(XmlNavigator xmlNavigator,
              URI rootUri)
                         throws PackagerException,
                                XPathExpressionException

Packages an XML Document to a zipped binary output stream.

Parameters:

xmlNavigator - The XmlNavigator containing the data.

rootUri - The root URI to use when dealing with relative URIs.

Throws:

PackagerException - If the XML document could not be packaged.

XPathExpressionException - If the JobId of the XJDF could not be read.

packageXml

protected final void packageXml(XmlNavigator xmlNavigator,
              String docName,
              URI rootUri)
                         throws PackagerException

Packages an XML document to a zipped binary output stream.

Parameters:

xmlNavigator - XML Navigator which is being packaged.

docName - File name of the document in the zip package.

rootUri - The root URI to use when dealing with relative URIs.

Throws:

PackagerException - If the XML document could not be packaged.