org.docx4j.openpackaging.io3.stores

Class UnzippedPartStore

java.lang.Object

org.docx4j.openpackaging.io3.stores.UnzippedPartStore

All Implemented Interfaces:

PartStore

public class UnzippedPartStore
extends java.lang.Object
implements PartStore

Load an unzipped package from the file system; save it to some output stream. TODO convert path sep in part name to suit underlying file system.

Since:

3.0

Author:

jharrop

Constructor Summary

Constructors

Constructor and Description
UnzippedPartStore(java.io.File dir)

Method Summary

Modifier and Type	Method and Description
void	dispose()
void	finishSave() Anything necessary to perfect the save operation.
long	getPartSize(java.lang.String partName) The size of this part in bytes.
java.io.InputStream	loadPart(java.lang.String partName) Returns null if the part does not exist.
void	rename(PartName oldName, PartName newName) Rename a part in the part store.
void	saveBinaryPart(Part part)
void	saveContentTypes(ContentTypeManager ctm)
void	saveCustomXmlDataStoragePart(CustomXmlDataStoragePart part)
void	saveJaxbXmlPart(JaxbXmlPart part)
void	saveXmlPart(XmlPart part)
void	setOutputStream(java.io.OutputStream os) Does nothing
void	setSourcePartStore(PartStore partStore) Set this if its different to the target part store (ie this object)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnzippedPartStore

public UnzippedPartStore(java.io.File dir)
                  throws Docx4JException

Throws:

Docx4JException

Method Detail

setSourcePartStore

public void setSourcePartStore(PartStore partStore)

Set this if its different to the target part store (ie this object)

Specified by:

setSourcePartStore in interface PartStore

loadPart

public java.io.InputStream loadPart(java.lang.String partName)
                             throws Docx4JException

Description copied from interface: PartStore

Returns null if the part does not exist. This will happen when calling code optimistically tries to fetch a rels part (which may or may not exist). Note: JaxbXmlPart and JaxbXmlPartXPathAware both unmarshal lazily (ie can invoke this sometime after the docx is loaded). Caller (generally docx4j itself) should close the resulting InputStream after use.

Specified by:

loadPart in interface PartStore

Returns:

Throws:

Docx4JException

getPartSize

public long getPartSize(java.lang.String partName)
                 throws Docx4JException

Description copied from interface: PartStore

The size of this part in bytes. Return -1 if the part does not exist.

Specified by:

getPartSize in interface PartStore

Returns:

Throws:

Docx4JException

rename

public void rename(PartName oldName,
                   PartName newName)

Description copied from interface: PartStore

Rename a part in the part store. Useful where a part is being renamed, but its content has not been loaded. (The existing approach is to manually force the content to be loaded)

Specified by:

rename in interface PartStore

Parameters:

oldName -

newName -

Since:

8.1.4

setOutputStream

public void setOutputStream(java.io.OutputStream os)

Does nothing

Specified by:

setOutputStream in interface PartStore

saveContentTypes

public void saveContentTypes(ContentTypeManager ctm)
                      throws Docx4JException

Specified by:

saveContentTypes in interface PartStore

Throws:

Docx4JException

saveJaxbXmlPart

public void saveJaxbXmlPart(JaxbXmlPart part)
                     throws Docx4JException

Specified by:

saveJaxbXmlPart in interface PartStore

Throws:

Docx4JException

saveCustomXmlDataStoragePart

public void saveCustomXmlDataStoragePart(CustomXmlDataStoragePart part)
                                  throws Docx4JException

Specified by:

saveCustomXmlDataStoragePart in interface PartStore

Throws:

Docx4JException

saveXmlPart

public void saveXmlPart(XmlPart part)
                 throws Docx4JException

Specified by:

saveXmlPart in interface PartStore

Throws:

Docx4JException

saveBinaryPart

public void saveBinaryPart(Part part)
                    throws Docx4JException

Specified by:

saveBinaryPart in interface PartStore

Throws:

Docx4JException

finishSave

public void finishSave()
                throws Docx4JException

Description copied from interface: PartStore

Anything necessary to perfect the save operation. For example,

Specified by:

finishSave in interface PartStore

Throws:

Docx4JException

dispose

public void dispose()

Specified by:

dispose in interface PartStore