uk.org.taverna.scufl2.ucfpackage

Class UCFPackage

java.lang.Object

uk.org.taverna.scufl2.ucfpackage.UCFPackage

All Implemented Interfaces:

Cloneable

public class UCFPackage
extends Object
implements Cloneable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UCFPackage.ResourceEntry

Field Summary

Fields

Modifier and Type	Field and Description
static String	MIME_BINARY
static String	MIME_DATA_BUNDLE
static String	MIME_EPUB
static String	MIME_RDF
static String	MIME_SERVICE_BUNDLE
static String	MIME_TEXT_PLAIN
static String	MIME_TEXT_XML
static String	MIME_WORKFLOW_BUNDLE
static String	MIME_WORKFLOW_RUN_BUNDLE

Constructor Summary

Constructors

Constructor and Description
UCFPackage()
UCFPackage(File containerFile)
UCFPackage(InputStream inputStream)

Method Summary

Methods

Modifier and Type	Method and Description
void	addResource(byte[] bytesValue, String path, String mediaType)
void	addResource(Document document, String path, String mediaType)
void	addResource(InputStream inputStream, String path, String mediaType)
void	addResource(String stringValue, String path, String mediaType)
void	addResource(URI uri, String path, String mediaType)
OutputStream	addResourceUsingOutputStream(String path, String mediaType)
UCFPackage	clone()
protected static Marshaller	createMarshaller()
protected static Unmarshaller	createUnMarshaller()
protected JAXBElement<Container>	getContainerXML()
protected static JAXBContext	getJaxbContext()
String	getPackageMediaType()
byte[]	getResourceAsBytes(String path)
InputStream	getResourceAsInputStream(String path)
String	getResourceAsString(String path)
UCFPackage.ResourceEntry	getResourceEntry(String path)
List<UCFPackage.ResourceEntry>	getRootFiles()
protected Container.RootFiles	getRootFiles(Container container)
String	getRootFileVersion(String rootFile)
Map<String,UCFPackage.ResourceEntry>	listAllResources()
Map<String,UCFPackage.ResourceEntry>	listResources()
Map<String,UCFPackage.ResourceEntry>	listResources(String folderPath)
protected Map<String,UCFPackage.ResourceEntry>	listResources(String folderPath, boolean recursive)
protected void	open(File containerFile)
protected void	open(InputStream inputStream)
protected void	parseContainerXML()
protected void	prepareAndSave(File tempFile)
protected void	prepareContainerXML()
void	removeResource(String path)
void	save(File packageFile)
void	save(OutputStream output)
void	setPackageMediaType(String mediaType)
void	setRootFile(String path)
void	setRootFile(String path, String version)
void	unsetRootFile(String path)

Methods inherited from class java.lang.Object

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

Field Detail

MIME_BINARY

public static final String MIME_BINARY

See Also:

Constant Field Values

MIME_TEXT_PLAIN

public static final String MIME_TEXT_PLAIN

See Also:

Constant Field Values

MIME_TEXT_XML

public static final String MIME_TEXT_XML

See Also:

Constant Field Values

MIME_RDF

public static final String MIME_RDF

See Also:

Constant Field Values

MIME_EPUB

public static final String MIME_EPUB

See Also:

Constant Field Values

MIME_WORKFLOW_BUNDLE

public static final String MIME_WORKFLOW_BUNDLE

See Also:

Constant Field Values

MIME_DATA_BUNDLE

public static final String MIME_DATA_BUNDLE

See Also:

Constant Field Values

MIME_WORKFLOW_RUN_BUNDLE

public static final String MIME_WORKFLOW_RUN_BUNDLE

See Also:

Constant Field Values

MIME_SERVICE_BUNDLE

public static final String MIME_SERVICE_BUNDLE

See Also:

Constant Field Values

Constructor Detail

UCFPackage

public UCFPackage()
           throws IOException

Throws:

IOException

UCFPackage

public UCFPackage(File containerFile)
           throws IOException

Throws:

IOException

UCFPackage

public UCFPackage(InputStream inputStream)
           throws IOException

Throws:

IOException

Method Detail

open

protected void open(File containerFile)
             throws IOException

Throws:

IOException

open

protected void open(InputStream inputStream)
             throws IOException

Throws:

IOException

parseContainerXML

protected void parseContainerXML()
                          throws IOException

Throws:

IOException

getPackageMediaType

public String getPackageMediaType()

setPackageMediaType

public void setPackageMediaType(String mediaType)

save

public void save(File packageFile)
          throws IOException

Throws:

IOException

prepareAndSave

protected void prepareAndSave(File tempFile)
                       throws IOException

Throws:

IOException

prepareContainerXML

protected void prepareContainerXML()
                            throws IOException

Throws:

IOException

createMarshaller

protected static Marshaller createMarshaller()
                                      throws JAXBException

Throws:

JAXBException

createUnMarshaller

protected static Unmarshaller createUnMarshaller()
                                          throws JAXBException

Throws:

JAXBException

getJaxbContext

protected static JAXBContext getJaxbContext()
                                     throws JAXBException

Throws:

JAXBException

addResource

public void addResource(String stringValue,
               String path,
               String mediaType)
                 throws IOException

Throws:

IOException

addResource

public void addResource(byte[] bytesValue,
               String path,
               String mediaType)
                 throws IOException

Throws:

IOException

addResource

public void addResource(Document document,
               String path,
               String mediaType)
                 throws IOException

Throws:

IOException

addResource

public void addResource(InputStream inputStream,
               String path,
               String mediaType)
                 throws IOException

Throws:

IOException

addResource

public void addResource(URI uri,
               String path,
               String mediaType)
                 throws IOException

Throws:

IOException

getResourceAsString

public String getResourceAsString(String path)
                           throws IOException

Throws:

IOException

getResourceAsBytes

public byte[] getResourceAsBytes(String path)
                          throws IOException

Throws:

IOException

getResourceAsInputStream

public InputStream getResourceAsInputStream(String path)
                                     throws IOException

Throws:

IOException

listResources

public Map<String,UCFPackage.ResourceEntry> listResources()

listResources

public Map<String,UCFPackage.ResourceEntry> listResources(String folderPath)

listResources

protected Map<String,UCFPackage.ResourceEntry> listResources(String folderPath,
                                                 boolean recursive)

removeResource

public void removeResource(String path)

listAllResources

public Map<String,UCFPackage.ResourceEntry> listAllResources()

setRootFile

public void setRootFile(String path)

setRootFile

public void setRootFile(String path,
               String version)

getRootFiles

protected Container.RootFiles getRootFiles(Container container)

getRootFiles

public List<UCFPackage.ResourceEntry> getRootFiles()

getResourceEntry

public UCFPackage.ResourceEntry getResourceEntry(String path)

unsetRootFile

public void unsetRootFile(String path)

getContainerXML

protected JAXBElement<Container> getContainerXML()

save

public void save(OutputStream output)
          throws IOException

Throws:

IOException

addResourceUsingOutputStream

public OutputStream addResourceUsingOutputStream(String path,
                                        String mediaType)
                                          throws IOException

Throws:

IOException

clone

public UCFPackage clone()

Overrides:

clone in class Object

getRootFileVersion

public String getRootFileVersion(String rootFile)