org.cip4.lib.xjdf.xml

Class XJdfPackager

java.lang.Object

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

org.cip4.lib.xjdf.xml.XJdfPackager

public class XJdfPackager
extends AbstractXmlPackager

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

Nested Class Summary

Nested classes/interfaces inherited from class org.cip4.lib.xjdf.xml.internal.AbstractXmlPackager

AbstractXmlPackager.CompressionLevel

Constructor Summary

Constructors

Constructor and Description
XJdfPackager(OutputStream out) Create a new XJdfPackager.
XJdfPackager(OutputStream out, boolean withoutHierarchy) Create a new XJdfPackager.

Method Summary

Methods

Modifier and Type	Method and Description
void	packageXJdf(XJdfNavigator xJdfNavigator, String docName, URI rootUri) Packages an XJDF Document to a zipped binary output stream.
void	packageXJdf(XJdfNavigator xJdfNavigator, URI rootUri) Packages an XJDF Document to a zipped binary output stream.
void	packageXml(XmlNavigator xJdfNavigator, URI rootUri) Packages an XML Document to a zipped binary output stream.

Methods inherited from class org.cip4.lib.xjdf.xml.internal.AbstractXmlPackager

packageXml, setCompressionLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

XJdfPackager

public XJdfPackager(OutputStream out)

Create a new XJdfPackager.

Parameters:

out - The underlying OutputStream to write the package to.

XJdfPackager

public XJdfPackager(OutputStream out,
            boolean withoutHierarchy)

Create a new XJdfPackager.

Parameters:

out - The underlying OutputStream to write the package to.

withoutHierarchy - Put all files into the zip root.

Method Detail

packageXml

public final void packageXml(XmlNavigator xJdfNavigator,
              URI rootUri)
                      throws PackagerException,
                             XPathExpressionException

Description copied from class: AbstractXmlPackager

Packages an XML Document to a zipped binary output stream.

Specified by:

packageXml in class AbstractXmlPackager

Parameters:

xJdfNavigator - 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.

packageXJdf

public final void packageXJdf(XJdfNavigator xJdfNavigator,
               URI rootUri)
                       throws PackagerException,
                              XPathExpressionException

Packages an XJDF Document to a zipped binary output stream.

Parameters:

xJdfNavigator - The XjdfNavigator 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.

packageXJdf

public final void packageXJdf(XJdfNavigator xJdfNavigator,
               String docName,
               URI rootUri)
                       throws PackagerException

Packages an XJDF Document to a zipped binary output stream.

Parameters:

xJdfNavigator - The XjdfNavigator containing the data.

docName - Documents name in ZIP Package.

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

Throws:

PackagerException - If the XJDF could not be packaged.