Package org.cip4.lib.xjdf.xml

Class XJdfUnpackager

java.lang.Object

org.cip4.lib.xjdf.xml.internal.AbstractXmlUnpackager

org.cip4.lib.xjdf.xml.XJdfUnpackager

public class XJdfUnpackager
extends AbstractXmlUnpackager

Unpackaging logic for XJDF Packages.

Constructor Summary

Constructors

Constructor	Description
XJdfUnpackager(java.lang.String pathPackage)	Custom constructor.

Method Summary

Modifier and Type	Method	Description
protected java.lang.String[]	getMasterExtension()	Defines the file extension of the master file.
XJdfNavigator	getXJdfDocument()	Returns the XJDF Document covered by the XJDFNavigator.
XJdfNavigator	getXJdfDocument(boolean namespaceAware)	Returns the XJDF Document covered by the XJDFNavigator.
java.lang.String	unpackageXJdf(java.lang.String targetDir)	Unpackage an XJDF Package to a target directory.
java.lang.String	unpackageXJdfTemp()	Unpackage an XJDF Package to a temporary directory.
java.lang.String	unpackageXJdfTemp(java.lang.String appName)	Unpackage an XJDF Package to a temporary directory.

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

extractFile, findMasterDocument, findMasterDocumentPath, unpackageZip, unpackageZipTemp, unpackageZipTemp

Methods inherited from class java.lang.Object

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

Constructor Detail

XJdfUnpackager

public XJdfUnpackager(java.lang.String pathPackage)
               throws java.io.IOException

Custom constructor. Accepting a XJDF Package Path for initializing.

Parameters:

pathPackage - Path to XJDF Package.

Throws:

java.io.IOException

Method Detail

getXJdfDocument

public XJdfNavigator getXJdfDocument()
                              throws java.lang.Exception

Returns the XJDF Document covered by the XJDFNavigator.

Returns:

XJDF Document coverd by the XJDFNavigator.

Throws:

java.lang.Exception

getXJdfDocument

public final XJdfNavigator getXJdfDocument(boolean namespaceAware)
                                    throws java.lang.Exception

Returns the XJDF Document covered by the XJDFNavigator.

Parameters:

namespaceAware - Flag whether or not the navigator should be aware of the namespaces.

Returns:

XJDF document covered by the XJDFNavigator.

Throws:

java.lang.Exception

unpackageXJdfTemp

public java.lang.String unpackageXJdfTemp(java.lang.String appName)
                                   throws java.io.IOException

Unpackage an XJDF Package to a temporary directory.

Returns:

The path of the master document.

Throws:

java.io.IOException

unpackageXJdfTemp

public java.lang.String unpackageXJdfTemp()
                                   throws java.io.IOException

Unpackage an XJDF Package to a temporary directory.

Returns:

The path of the master document.

Throws:

java.io.IOException

unpackageXJdf

public java.lang.String unpackageXJdf(java.lang.String targetDir)
                               throws java.io.IOException

Unpackage an XJDF Package to a target directory.

Parameters:

targetDir - Target directory for unpackaging.

Returns:

The path of the master document.

Throws:

java.io.IOException

getMasterExtension

protected java.lang.String[] getMasterExtension()

Description copied from class: AbstractXmlUnpackager

Defines the file extension of the master file.

Specified by:

getMasterExtension in class AbstractXmlUnpackager

Returns:

Array of master file extensions.

See Also:

AbstractXmlUnpackager.getMasterExtension()