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.

Author:

s.meissner

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(byte[] xjdf) Custom constructor.
XJdfPackager(byte[] xjdf, String rootPath) Custom constructor.
XJdfPackager(String xjdfPath) Custom constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	packageXJdf(OutputStream os) Packages an XJDF Document to a zipped binary output stream.
void	packageXJdf(OutputStream os, String docName) Packages an XJDF Document to a zipped binary output stream.
void	packageXJdf(OutputStream os, String docName, boolean withoutHierarchy) Packages an XJDF Document to a zipped binary output stream.

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

getCompressionLevel, getXmlDoc, packageXml, registerFile, registerFiles, setCompressionLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

XJdfPackager

public XJdfPackager(String xjdfPath)
             throws Exception

Custom constructor. Accepting an XJDF Path for initializing.

Parameters:

xjdfPath - Path to XJDF Document.

Throws:

Exception

XJdfPackager

public XJdfPackager(byte[] xjdf)
             throws Exception

Custom constructor. Accepting an XJDF Document for initializing.

Parameters:

xJdf - XJDF Document byte array for packaging.

Throws:

Exception

XJdfPackager

public XJdfPackager(byte[] xjdf,
            String rootPath)
             throws Exception

Custom constructor. Accepting an XJDF Document for initializing.

Parameters:

xJdf - XJDF Document byte array for packaging.

rootPath - The root path of the document.

Throws:

Exception

Method Detail

packageXJdf

public void packageXJdf(OutputStream os)
                 throws Exception

Packages an XJDF Document to a zipped binary output stream.

Parameters:

os - Target OutputStream where XJdfDocument is being packaged.

Throws:

Exception

packageXJdf

public void packageXJdf(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.

docName - Documents name in ZIP Package.

Throws:

Exception

packageXJdf

public void packageXJdf(OutputStream os,
               String docName,
               boolean withoutHierarchy)
                 throws Exception

Packages an XJDF Document to a zipped binary output stream.

Parameters:

os - Target OutputStream where XJdfDocument is being packaged.

docName - Documents name in ZIP Package.

withoutHierarchy - Put all files into the ZIP Root.

Throws:

Exception