org.docx4j.openpackaging.packages

Class OpcPackage

java.lang.Object

org.docx4j.openpackaging.Base

org.docx4j.openpackaging.packages.OpcPackage

Direct Known Subclasses:

GloxPackage, PresentationMLPackage, SpreadsheetMLPackage, WordprocessingMLPackage

public class OpcPackage
extends Base

Represent a Package as defined in the Open Packaging Specification.

Author:

Jason Harrop

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentTypeManager	contentTypeManager
protected HashMap<String,CustomXmlPart>	customXmlDataStorageParts
protected DocPropsCorePart	docPropsCorePart
protected DocPropsCustomPart	docPropsCustomPart
protected DocPropsExtendedPart	docPropsExtendedPart
protected HashMap<ExternalTarget,Part>	externalResources
HashMap<String,String>	handled This HashMap is intended to prevent loops during the loading of this package.
protected Parts	parts Package parts collection.

Fields inherited from class org.docx4j.openpackaging.Base

contentType, partName, relationships

Constructor Summary

Constructors

Constructor and Description
OpcPackage() Constructor.
OpcPackage(ContentTypeManager contentTypeManager) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
OpcPackage	clone()
ContentTypeManager	getContentTypeManager()
HashMap<String,CustomXmlPart>	getCustomXmlDataStorageParts()
DocPropsCorePart	getDocPropsCorePart()
DocPropsCustomPart	getDocPropsCustomPart() Get DocPropsCustomPart, if any.
DocPropsExtendedPart	getDocPropsExtendedPart()
HashMap<ExternalTarget,Part>	getExternalResources()
OpcPackage	getPackage()
Parts	getParts() Retrieve the Parts object.
PartStore	getSourcePartStore()
PartStore	getTargetPartStore()
String	getTitle()
static OpcPackage	load(File docxFile) Convenience method to create a WordprocessingMLPackage or PresentationMLPackage from an existing File (.docx/.docxm, .ppxtx or Flat OPC .xml).
static OpcPackage	load(File docxFile, String password) Convenience method to create a WordprocessingMLPackage or PresentationMLPackage from an existing File (.docx/.docxm, .ppxtx or Flat OPC .xml).
static OpcPackage	load(InputStream inputStream) Convenience method to create a WordprocessingMLPackage or PresentationMLPackage from an inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml).
static OpcPackage	load(InputStream is, boolean docxFormat) Deprecated.
static OpcPackage	load(InputStream is, Filetype type) convenience method to load a word2007 document from an existing inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml).
static OpcPackage	load(InputStream is, Filetype type, String password) convenience method to load a word2007 document from an existing inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml).
static OpcPackage	load(InputStream inputStream, String password) Convenience method to create a WordprocessingMLPackage or PresentationMLPackage from an inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml).
void	save(File file) Convenience method to save a WordprocessingMLPackage or PresentationMLPackage to a File.
void	setContentTypeManager(ContentTypeManager contentTypeManager)
boolean	setPartShortcut(Part part, String relationshipType) Tell the source Part about this target Part, so the source can use this part via a convenience method.
void	setSourcePartStore(PartStore partStore)
void	setTargetPartStore(PartStore partStore)
void	setTitle(String title)

Methods inherited from class org.docx4j.openpackaging.Base

addTargetPart, addTargetPart, addTargetPart, addTargetPart, getContentType, getPartName, getRelationshipsPart, getRelationshipsPart, getUserData, setContentType, setRelationships, setUserData

Methods inherited from class java.lang.Object

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

Field Detail

handled

public HashMap<String,String> handled

This HashMap is intended to prevent loops during the loading of this package. TODO This doesn't really tell us anything that the contents of Parts couldn't also tell us (except that that doesn't contain the rels parts), so consider removing. At least replace it with a method, so this implementation detail is hidden!

parts

protected Parts parts

Package parts collection. This is a collection of _all_ parts in the package (_except_ relationship parts), not just those referred to by the package-level relationships. It doesn't include external resources.

externalResources

protected HashMap<ExternalTarget,Part> externalResources

customXmlDataStorageParts

protected HashMap<String,CustomXmlPart> customXmlDataStorageParts

contentTypeManager

protected ContentTypeManager contentTypeManager

docPropsCorePart

protected DocPropsCorePart docPropsCorePart

docPropsExtendedPart

protected DocPropsExtendedPart docPropsExtendedPart

docPropsCustomPart

protected DocPropsCustomPart docPropsCustomPart

Constructor Detail

OpcPackage

public OpcPackage()

Constructor. Also creates a new content type manager

OpcPackage

public OpcPackage(ContentTypeManager contentTypeManager)

Constructor.

Parameters:

contentTypeManager - The content type manager to use

Method Detail

getParts

public Parts getParts()

Retrieve the Parts object.

getExternalResources

public HashMap<ExternalTarget,Part> getExternalResources()

getCustomXmlDataStorageParts

public HashMap<String,CustomXmlPart> getCustomXmlDataStorageParts()

getContentTypeManager

public ContentTypeManager getContentTypeManager()

setContentTypeManager

public void setContentTypeManager(ContentTypeManager contentTypeManager)

getSourcePartStore

public PartStore getSourcePartStore()

Returns:

the partStore

Since:

3.0.

setSourcePartStore

public void setSourcePartStore(PartStore partStore)

Parameters:

partStore - the partStore to set

Since:

3.0.

getTargetPartStore

public PartStore getTargetPartStore()

Returns:

the partStore

Since:

3.0.

setTargetPartStore

public void setTargetPartStore(PartStore partStore)

Parameters:

partStore - the partStore to set

Since:

3.0.

getPackage

public OpcPackage getPackage()

Specified by:

getPackage in class Base

load

public static OpcPackage load(File docxFile)
                       throws Docx4JException

Convenience method to create a WordprocessingMLPackage or PresentationMLPackage from an existing File (.docx/.docxm, .ppxtx or Flat OPC .xml).

Parameters:

docxFile - The docx file

Throws:

Docx4JException

load

public static OpcPackage load(File docxFile,
              String password)
                       throws Docx4JException

Convenience method to create a WordprocessingMLPackage or PresentationMLPackage from an existing File (.docx/.docxm, .ppxtx or Flat OPC .xml).

Parameters:

docxFile - The docx file

password - The password, if the file is password protected (compound)

Throws:

Docx4JException

load

public static OpcPackage load(InputStream inputStream)
                       throws Docx4JException

Convenience method to create a WordprocessingMLPackage or PresentationMLPackage from an inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml). It detects the convenient format inspecting two first bytes of stream (magic bytes). For office 2007 'x' formats, these two bytes are 'PK' (same as zip file)

Parameters:

inputStream - The docx file

Throws:

Docx4JException

load

public static OpcPackage load(InputStream inputStream,
              String password)
                       throws Docx4JException

Convenience method to create a WordprocessingMLPackage or PresentationMLPackage from an inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml). It detects the convenient format inspecting two first bytes of stream (magic bytes). For office 2007 'x' formats, these two bytes are 'PK' (same as zip file)

Parameters:

inputStream - The docx file

password - The password, if the file is password protected (compound)

Throws:

Docx4JException

load

@Deprecated
public static OpcPackage load(InputStream is,
                         boolean docxFormat)
                       throws Docx4JException

Deprecated.

convenience method to load a word2007 document from an existing inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml). Included for backwards compatibility

Parameters:

is -

docxFormat -

Returns:

Throws:

Docx4JException

load

public static OpcPackage load(InputStream is,
              Filetype type)
                       throws Docx4JException

convenience method to load a word2007 document from an existing inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml).

Parameters:

is -

docxFormat -

Returns:

Throws:

Docx4JException

load

public static OpcPackage load(InputStream is,
              Filetype type,
              String password)
                       throws Docx4JException

convenience method to load a word2007 document from an existing inputstream (.docx/.docxm, .ppxtx or Flat OPC .xml).

Parameters:

is -

docxFormat -

Returns:

Throws:

Docx4JException

save

public void save(File file)
          throws Docx4JException

Convenience method to save a WordprocessingMLPackage or PresentationMLPackage to a File.

Parameters:

file - The docx file

Throws:

Docx4JException

setPartShortcut

public boolean setPartShortcut(Part part,
                      String relationshipType)

Description copied from class: Base

Tell the source Part about this target Part, so the source can use this part via a convenience method.

Specified by:

setPartShortcut in class Base

Returns:

true if the source Part does use the target Part in a convenience method.

getDocPropsCorePart

public DocPropsCorePart getDocPropsCorePart()

getDocPropsExtendedPart

public DocPropsExtendedPart getDocPropsExtendedPart()

getDocPropsCustomPart

public DocPropsCustomPart getDocPropsCustomPart()

Get DocPropsCustomPart, if any.

Returns:

setTitle

public void setTitle(String title)

Since:

3.0.0

getTitle

public String getTitle()

Since:

3.0.0

clone

public OpcPackage clone()

Overrides:

clone in class Object

Since:

2.7.2