Package org.cip4.lib.xjdf

Class XJmfZipPackage

java.lang.Object

org.cip4.lib.xjdf.XJmfZipPackage

public class XJmfZipPackage
extends java.lang.Object

This class provides functionality all about packaging.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XJmfZipPackage.Builder	ZipPackage builder class.

Constructor Summary

Constructors

Constructor	Description
XJmfZipPackage()	Default constructor.
XJmfZipPackage(byte[] zipArchive)	Custom constructor.
XJmfZipPackage(XJmfMessage rootJmf)	Custom constructor.
XJmfZipPackage(XJmfMessage rootJmf, @NotNull java.util.Map<URI,XJdfDocument> xJdfDocuments)	Custom constructor.
XJmfZipPackage(XJmfMessage rootJmf, @NotNull java.util.Map<URI,XJdfDocument> xJdfDocuments, @NotNull java.util.Map<URI,byte[]> files)	Custom constructor.

Method Summary

Modifier and Type	Method	Description
byte[]	getFile(java.lang.String uri)	Returns a file as byte array.
byte[]	getFile(URI uri)	Returns a file as byte array.
XJdfDocument	getXJdfDocument(java.lang.String uri)	Returns an XJDF Document by uri.
XJdfDocument	getXJdfDocument(URI uri)	Returns an XJDF Document by uri.
XJmfMessage	getXJmfRoot()	Returns the XJMF Root Message in the package.
java.util.Set<URI>	listFiles()	Returns list of all files.
byte[]	packageFiles()	Packages files to a zip archive.

Methods inherited from class java.lang.Object

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

Constructor Detail

XJmfZipPackage

public XJmfZipPackage()

Default constructor.

XJmfZipPackage

public XJmfZipPackage(XJmfMessage rootJmf)
               throws XJdfValidationException,
                      XJdfParseException

Custom constructor.
Accepting a root XJMF and a map of XJDF Documents for initializing.

Parameters:

rootJmf - The root xjmf message.

Throws:

XJdfValidationException

XJdfParseException

XJmfZipPackage

public XJmfZipPackage(XJmfMessage rootJmf,
                      @NotNull
                      @NotNull java.util.Map<URI,XJdfDocument> xJdfDocuments)
               throws XJdfValidationException,
                      XJdfParseException

Custom constructor.
Accepting a root XJMF and a map of XJDF Documents for initializing.

Parameters:

rootJmf - The root xjmf message.

xJdfDocuments - Map of XJDF Documents

Throws:

XJdfValidationException

XJdfParseException

XJmfZipPackage

public XJmfZipPackage(XJmfMessage rootJmf,
                      @NotNull
                      @NotNull java.util.Map<URI,XJdfDocument> xJdfDocuments,
                      @NotNull
                      @NotNull java.util.Map<URI,byte[]> files)
               throws XJdfValidationException,
                      XJdfParseException

Custom constructor.
Accepting a root XJMF and a map of XJDF Documents for initializing.

Parameters:

rootJmf - The root xjmf message.

xJdfDocuments - Map of XJDF Documents

files - Map of files

Throws:

XJdfValidationException

XJdfParseException

XJmfZipPackage

public XJmfZipPackage(byte[] zipArchive)
               throws java.io.IOException,
                      java.net.URISyntaxException

Custom constructor.
Accepting a zip archive for initializing.

Throws:

java.io.IOException

java.net.URISyntaxException

Method Detail

listFiles

public java.util.Set<URI> listFiles()

Returns list of all files.

Returns:

Set of file URIs.

getFile

public byte[] getFile(java.lang.String uri)
               throws java.net.URISyntaxException

Returns a file as byte array.

Parameters:

uri - The uri as string.

Returns:

The file as byte array.

Throws:

java.net.URISyntaxException

getFile

public byte[] getFile(URI uri)

Returns a file as byte array.

Parameters:

uri - The uri object.

Returns:

The file as byte array.

getXJdfDocument

public XJdfDocument getXJdfDocument(java.lang.String uri)
                             throws XJdfInitException,
                                    XJdfParseException,
                                    java.net.URISyntaxException

Returns an XJDF Document by uri.

Parameters:

uri - The uri object.

Returns:

The XJDF Document.

Throws:

XJdfInitException

XJdfParseException

java.net.URISyntaxException

getXJdfDocument

public XJdfDocument getXJdfDocument(URI uri)
                             throws XJdfInitException,
                                    XJdfParseException

Returns an XJDF Document by uri.

Parameters:

uri - The uri object.

Returns:

The XJDF Document.

Throws:

XJdfInitException

XJdfParseException

getXJmfRoot

public XJmfMessage getXJmfRoot()
                        throws XJdfInitException,
                               XJdfParseException

Returns the XJMF Root Message in the package.

Returns:

The XJMF root message.

Throws:

XJdfInitException

XJdfParseException

packageFiles

public byte[] packageFiles()
                    throws java.io.IOException

Packages files to a zip archive.

Returns:

The zip packaged files as byte array.

Throws:

java.io.IOException