org.apache.poi

Class POIXMLDocumentPart

java.lang.Object

org.apache.poi.POIXMLDocumentPart

Direct Known Subclasses:

CalculationChain, CommentsTable, MapInfo, POIXMLDocument, SharedStringsTable, SingleXmlCells, StylesTable, ThemesTable, XSLFChart, XSLFCommentAuthors, XSLFComments, XSLFPictureData, XSLFSheet, XSLFTableStyles, XSLFTheme, XSSFChart, XSSFDrawing, XSSFPictureData, XSSFSheet, XSSFTable, XSSFVMLDrawing, XWPFFootnotes, XWPFHeaderFooter, XWPFNumbering, XWPFPictureData, XWPFSettings, XWPFStyles

public class POIXMLDocumentPart
extends Object

Represents an entry of a OOXML package.

Each POIXMLDocumentPart keeps a reference to the underlying a PackagePart.

Author:

Yegor Kozlov

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.xmlbeans.XmlOptions	DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Constructor and Description
POIXMLDocumentPart() Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.
POIXMLDocumentPart(OPCPackage pkg) Construct POIXMLDocumentPart representing a "core document" package part.
POIXMLDocumentPart(PackagePart part, PackageRelationship rel) Creates an POIXMLDocumentPart representing the given package part and relationship.
POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel) Creates an POIXMLDocumentPart representing the given package part, relationship and parent Called by read(POIXMLFactory, java.util.Map) when reading in an exisiting file.

Method Summary

Methods

Modifier and Type	Method and Description
void	addRelation(String id, POIXMLDocumentPart part) Add a new child POIXMLDocumentPart
protected void	commit() Save the content in the underlying package part.
POIXMLDocumentPart	createRelationship(POIXMLRelation descriptor, POIXMLFactory factory) Create a new child POIXMLDocumentPart
POIXMLDocumentPart	createRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx)
protected POIXMLDocumentPart	createRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx, boolean noRelation) Create a new child POIXMLDocumentPart
PackagePart	getPackagePart() Provides access to the underlying PackagePart
PackageRelationship	getPackageRelationship() Provides access to the PackageRelationship that identifies this POIXMLDocumentPart
POIXMLDocumentPart	getParent() Returns the parent POIXMLDocumentPart.
POIXMLDocumentPart	getRelationById(String id) Returns the target POIXMLDocumentPart, where a PackageRelationship is set from the PackagePart of this POIXMLDocumentPart to the PackagePart of the target POIXMLDocumentPart with a PackageRelationship.getId() matching the given parameter value.
String	getRelationId(POIXMLDocumentPart part) Returns the PackageRelationship.getId() of the PackageRelationship, that sources from the PackagePart of this POIXMLDocumentPart to the PackagePart of the given parameter value.
List<POIXMLDocumentPart>	getRelations() Returns the list of child relations for this POIXMLDocumentPart
protected PackagePart	getTargetPart(PackageRelationship rel) Get the PackagePart that is the target of a relationship from this Part.
protected void	onDocumentCreate() Fired when a new package part is created
protected void	onDocumentRead() Fired when a package part is read
protected void	onDocumentRemove() Fired when a package part is about to be removed from the package
protected void	onSave(Set<PackagePart> alreadySaved) Save changes in the underlying OOXML package.
protected void	prepareForCommit() Ensure that a memory based package part does not have lingering data from previous commit() calls.
protected void	read(POIXMLFactory factory, Map<PackagePart,POIXMLDocumentPart> context) Iterate through the underlying PackagePart and create child POIXMLFactory instances using the specified factory
protected void	rebase(OPCPackage pkg) When you open something like a theme, call this to re-base the XML Document onto the core child of the current core document
protected void	removeRelation(POIXMLDocumentPart part) Remove the relation to the specified part in this package and remove the part, if it is no longer needed.
protected boolean	removeRelation(POIXMLDocumentPart part, boolean removeUnusedParts) Remove the relation to the specified part in this package and remove the part, if it is no longer needed and flag is set to true.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_XML_OPTIONS

public static final org.apache.xmlbeans.XmlOptions DEFAULT_XML_OPTIONS

Constructor Detail

POIXMLDocumentPart

public POIXMLDocumentPart(OPCPackage pkg)

Construct POIXMLDocumentPart representing a "core document" package part.

POIXMLDocumentPart

public POIXMLDocumentPart()

Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.

See Also:

createRelationship(POIXMLRelation, POIXMLFactory, int, boolean)

POIXMLDocumentPart

public POIXMLDocumentPart(PackagePart part,
                  PackageRelationship rel)

Creates an POIXMLDocumentPart representing the given package part and relationship. Called by read(POIXMLFactory, java.util.Map) when reading in an exisiting file.

Parameters:

part - - The package part that holds xml data represenring this sheet.

rel - - the relationship of the given package part

See Also:

read(POIXMLFactory, java.util.Map)

POIXMLDocumentPart

public POIXMLDocumentPart(POIXMLDocumentPart parent,
                  PackagePart part,
                  PackageRelationship rel)

Creates an POIXMLDocumentPart representing the given package part, relationship and parent Called by read(POIXMLFactory, java.util.Map) when reading in an exisiting file.

Parameters:

parent - - Parent part

part - - The package part that holds xml data represenring this sheet.

rel - - the relationship of the given package part

See Also:

read(POIXMLFactory, java.util.Map)

Method Detail

rebase

protected final void rebase(OPCPackage pkg)
                     throws InvalidFormatException

When you open something like a theme, call this to re-base the XML Document onto the core child of the current core document

Throws:

InvalidFormatException

getPackagePart

public final PackagePart getPackagePart()

Provides access to the underlying PackagePart

Returns:

the underlying PackagePart

getPackageRelationship

public final PackageRelationship getPackageRelationship()

Provides access to the PackageRelationship that identifies this POIXMLDocumentPart

Returns:

the PackageRelationship that identifies this POIXMLDocumentPart

getRelations

public final List<POIXMLDocumentPart> getRelations()

Returns the list of child relations for this POIXMLDocumentPart

Returns:

child relations

getRelationById

public final POIXMLDocumentPart getRelationById(String id)

Returns the target POIXMLDocumentPart, where a PackageRelationship is set from the PackagePart of this POIXMLDocumentPart to the PackagePart of the target POIXMLDocumentPart with a PackageRelationship.getId() matching the given parameter value.

Parameters:

id - The relation id to look for

Returns:

the target part of the relation, or null, if none exists

getRelationId

public final String getRelationId(POIXMLDocumentPart part)

Returns the PackageRelationship.getId() of the PackageRelationship, that sources from the PackagePart of this POIXMLDocumentPart to the PackagePart of the given parameter value.

Parameters:

part - The POIXMLDocumentPart for which the according relation-id shall be found.

Returns:

The value of the PackageRelationship.getId() or null, if parts are not related.

addRelation

public final void addRelation(String id,
               POIXMLDocumentPart part)

Add a new child POIXMLDocumentPart

Parameters:

part - the child to add

removeRelation

protected final void removeRelation(POIXMLDocumentPart part)

Remove the relation to the specified part in this package and remove the part, if it is no longer needed.

removeRelation

protected final boolean removeRelation(POIXMLDocumentPart part,
                     boolean removeUnusedParts)

Remove the relation to the specified part in this package and remove the part, if it is no longer needed and flag is set to true.

Parameters:

part - The related part, to which the relation shall be removed.

removeUnusedParts - true, if the part shall be removed from the package if not needed any longer.

getParent

public final POIXMLDocumentPart getParent()

Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.

Returns:

the parent POIXMLDocumentPart or null for the root element.

toString

public String toString()

Overrides:

toString in class Object

commit

protected void commit()
               throws IOException

Save the content in the underlying package part. Default implementation is empty meaning that the package part is left unmodified. Sub-classes should override and add logic to marshal the "model" into Ooxml4J. For example, the code saving a generic XML entry may look as follows:

 protected void commit() throws IOException {
   PackagePart part = getPackagePart();
   OutputStream out = part.getOutputStream();
   XmlObject bean = getXmlBean(); //the "model" which holds changes in memory
   bean.save(out, DEFAULT_XML_OPTIONS);
   out.close();
 }
  

Throws:

IOException

onSave

protected final void onSave(Set<PackagePart> alreadySaved)
                     throws IOException

Save changes in the underlying OOXML package. Recursively fires commit() for each package part

Parameters:

alreadySaved - context set containing already visited nodes

Throws:

IOException

prepareForCommit

protected void prepareForCommit()

Ensure that a memory based package part does not have lingering data from previous commit() calls. Note: This is overwritten for some objects, as *PictureData seem to store the actual content in the part directly without keeping a copy like all others therefore we need to handle them differently.

createRelationship

public final POIXMLDocumentPart createRelationship(POIXMLRelation descriptor,
                                    POIXMLFactory factory)

Create a new child POIXMLDocumentPart

Parameters:

descriptor - the part descriptor

factory - the factory that will create an instance of the requested relation

Returns:

the created child POIXMLDocumentPart

createRelationship

public final POIXMLDocumentPart createRelationship(POIXMLRelation descriptor,
                                    POIXMLFactory factory,
                                    int idx)

createRelationship

protected final POIXMLDocumentPart createRelationship(POIXMLRelation descriptor,
                                    POIXMLFactory factory,
                                    int idx,
                                    boolean noRelation)

Create a new child POIXMLDocumentPart

Parameters:

descriptor - the part descriptor

factory - the factory that will create an instance of the requested relation

idx - part number

noRelation - if true, then no relationship is added.

Returns:

the created child POIXMLDocumentPart

read

protected void read(POIXMLFactory factory,
        Map<PackagePart,POIXMLDocumentPart> context)
             throws OpenXML4JException

Iterate through the underlying PackagePart and create child POIXMLFactory instances using the specified factory

Parameters:

factory - the factory object that creates POIXMLFactory instances

context - context map containing already visited noted keyed by targetURI

Throws:

OpenXML4JException

getTargetPart

protected PackagePart getTargetPart(PackageRelationship rel)
                             throws InvalidFormatException

Get the PackagePart that is the target of a relationship from this Part.

Parameters:

rel - The relationship

Returns:

The target part

Throws:

InvalidFormatException

onDocumentCreate

protected void onDocumentCreate()
                         throws IOException

Fired when a new package part is created

Throws:

IOException

onDocumentRead

protected void onDocumentRead()
                       throws IOException

Fired when a package part is read

Throws:

IOException

onDocumentRemove

protected void onDocumentRemove()
                         throws IOException

Fired when a package part is about to be removed from the package

Throws:

IOException