Class POIXMLDocumentPart
- Direct Known Subclasses:
CalculationChain,CommentsTable,ExternalLinksTable,MapInfo,POIXMLDocument,SharedStringsTable,SingleXmlCells,StylesTable,ThemesTable,XDDFChart,XDGFXMLDocumentPart,XSLFCommentAuthors,XSLFComments,XSLFObjectData,XSLFPictureData,XSLFSheet,XSLFTableStyles,XSLFTheme,XSSFDrawing,XSSFPictureData,XSSFPivotCache,XSSFPivotCacheDefinition,XSSFPivotCacheRecords,XSSFPivotTable,XSSFSheet,XSSFTable,XSSFVBAPart,XSSFVMLDrawing,XWPFAbstractFootnotesEndnotes,XWPFHeaderFooter,XWPFNumbering,XWPFPictureData,XWPFSettings,XWPFStyles
Each POIXMLDocumentPart keeps a reference to the underlying a PackagePart.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classThe RelationPart is a cached relationship between the document, which contains the RelationPart, and one of its referenced child document parts. -
Constructor Summary
ConstructorsConstructorDescriptionCreates new POIXMLDocumentPart - called by client code to create new parts from scratch.POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part) Creates an POIXMLDocumentPart representing the given package part, relationship and parent Called byread(POIXMLFactory, java.util.Map)when reading in an existing file.Construct POIXMLDocumentPart representing a "core document" package part.POIXMLDocumentPart(OPCPackage pkg, String coreDocumentRel) Construct POIXMLDocumentPart representing a custom "core document" package part.Creates an POIXMLDocumentPart representing the given package part and relationship. -
Method Summary
Modifier and TypeMethodDescriptionstatic voidDeprecated.addRelation(String relId, POIXMLRelation relationshipType, POIXMLDocumentPart part) Add a new child POIXMLDocumentPartprotected voidcommit()Save the content in the underlying package part.final POIXMLDocumentPartcreateRelationship(POIXMLRelation descriptor, POIXMLFactory factory) Create a new child POIXMLDocumentPartfinal POIXMLDocumentPartcreateRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx) Create a new child POIXMLDocumentPartcreateRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx, boolean noRelation) Create a new child POIXMLDocumentPartprotected final intgetNextPartNumber(POIXMLRelation descriptor, int minIdx) Identifies the next available part number for a part of the given type, if possible, otherwise -1 if none are available.final PackagePartProvides access to the underlying PackagePartfinal POIXMLDocumentPartReturns the parent POIXMLDocumentPart.final POIXMLDocumentPartReturns the targetPOIXMLDocumentPart, where aPackageRelationshipis set from thePackagePartof thisPOIXMLDocumentPartto thePackagePartof the targetPOIXMLDocumentPartwith aPackageRelationship.getId()matching the given parameter value.final StringReturns the firstPackageRelationship.getId()of thePackageRelationship, that sources from thePackagePartof thisPOIXMLDocumentPartto thePackagePartof the given parameter value.Returns the targetPOIXMLDocumentPart.RelationPart, where aPackageRelationshipis set from thePackagePartof thisPOIXMLDocumentPartto thePackagePartof the targetPOIXMLDocumentPartwith aPackageRelationship.getId()matching the given parameter value.Returns the list of child relations for this POIXMLDocumentPartfinal List<POIXMLDocumentPart>Returns the list of child relations for this POIXMLDocumentPartprotected PackagePartGet the PackagePart that is the target of a relationship from this Part.booleanto check whether embedded part is already committedprotected voidFired when a new package part is createdprotected voidFired when a package part is readprotected voidFired when a package part is about to be removed from the packageprotected final voidonSave(Set<PackagePart> alreadySaved) Save changes in the underlying OOXML package.protected voidEnsure that a memory based package part does not have lingering data from previous commit() calls.protected voidread(POIXMLFactory factory, Map<PackagePart, POIXMLDocumentPart> context) Iterate through the underlying PackagePart and create child POIXMLFactory instances using the specified factoryprotected final voidrebase(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 documentprotected final voidremoveRelation(String partId) Remove the relation to the specified part in this package and remove the part, if it is no longer needed.protected final voidRemove the relation to the specified part in this package and remove the part, if it is no longer needed.protected final booleanremoveRelation(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.voidsetCommited(boolean isCommited) setter method to set embedded part is committedtoString()
-
Constructor Details
-
POIXMLDocumentPart
Construct POIXMLDocumentPart representing a "core document" package part.- Parameters:
pkg- the OPCPackage containing this document
-
POIXMLDocumentPart
Construct POIXMLDocumentPart representing a custom "core document" package part.- Parameters:
pkg- the OPCPackage containing this documentcoreDocumentRel- the relation type of this document
-
POIXMLDocumentPart
public POIXMLDocumentPart()Creates new POIXMLDocumentPart - called by client code to create new parts from scratch. -
POIXMLDocumentPart
Creates an POIXMLDocumentPart representing the given package part and relationship. Called byread(POIXMLFactory, java.util.Map)when reading in an existing file.- Parameters:
part- - The package part that holds xml data representing this sheet.- Since:
- POI 3.14-Beta1
- See Also:
-
POIXMLDocumentPart
Creates an POIXMLDocumentPart representing the given package part, relationship and parent Called byread(POIXMLFactory, java.util.Map)when reading in an existing file.- Parameters:
parent- - Parent partpart- - The package part that holds xml data representing this sheet.- Since:
- POI 3.14-Beta1
- See Also:
-
-
Method Details
-
isCommited
public boolean isCommited()to check whether embedded part is already committed- Returns:
- return true if embedded part is committed
-
setCommited
public void setCommited(boolean isCommited) setter method to set embedded part is committed- Parameters:
isCommited- boolean value
-
rebase
When you open something like a theme, call this to re-base the XML Document onto the core child of the current core document- Parameters:
pkg- the package to be rebased- Throws:
InvalidFormatException- if there was an error in the core document relationIllegalStateException- if there are more than one core document relations
-
getPackagePart
Provides access to the underlying PackagePart- Returns:
- the underlying PackagePart
-
getRelations
Returns the list of child relations for this POIXMLDocumentPart- Returns:
- child relations
-
getRelationParts
Returns the list of child relations for this POIXMLDocumentPart- Returns:
- child relations
-
getRelationById
Returns the targetPOIXMLDocumentPart, where aPackageRelationshipis set from thePackagePartof thisPOIXMLDocumentPartto thePackagePartof the targetPOIXMLDocumentPartwith aPackageRelationship.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
-
getRelationPartById
Returns the targetPOIXMLDocumentPart.RelationPart, where aPackageRelationshipis set from thePackagePartof thisPOIXMLDocumentPartto thePackagePartof the targetPOIXMLDocumentPartwith aPackageRelationship.getId()matching the given parameter value.- Parameters:
id- The relation id to look for- Returns:
- the target relation part, or null, if none exists
- Since:
- 4.0.0
-
getRelationId
Returns the firstPackageRelationship.getId()of thePackageRelationship, that sources from thePackagePartof thisPOIXMLDocumentPartto thePackagePartof the given parameter value.There can be multiple references to the given
POIXMLDocumentPartand only the first in the order of creation is returned.- Parameters:
part- ThePOIXMLDocumentPartfor 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 POIXMLDocumentPart.RelationPart addRelation(String relId, POIXMLRelation relationshipType, POIXMLDocumentPart part) Add a new child POIXMLDocumentPart- Parameters:
relId- the preferred relation id, when null the next free relation id will be usedrelationshipType- the package relationship typepart- the child to add- Returns:
- the new RelationPart
- Since:
- 3.14-Beta1
-
removeRelation
Remove the relation to the specified part in this package and remove the part, if it is no longer needed.If there are multiple relationships to the same part, this will only remove the first relationship in the order of creation. The removal via the part id (
removeRelation(String)is preferred.- Parameters:
part- the part which relation is to be removed from this document
-
removeRelation
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.If there are multiple relationships to the same part, this will only remove the first relationship in the order of creation. The removal via the part id (
removeRelation(String, boolean)is preferred.- 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.- Returns:
- true, if the relation was removed
-
removeRelation
Remove the relation to the specified part in this package and remove the part, if it is no longer needed.If there are multiple relationships to the same part, this will only remove the first relationship in the order of creation. The removal via the part id (
removeRelation(String)is preferred.- Parameters:
partId- the part id which relation is to be removed from this document- Since:
- 4.0.0
-
getParent
Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.- Returns:
- the parent POIXMLDocumentPart or
nullfor the root element.
-
toString
-
commit
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- a subclass may throw an IOException if the changes can't be committed
-
onSave
Save changes in the underlying OOXML package. Recursively firescommit()for each package part- Parameters:
alreadySaved- context set containing already visited nodes- Throws:
IOException- a related part may throw an IOException if the changes can't be saved
-
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 descriptorfactory- the factory that will create an instance of the requested relation- Returns:
- the created child POIXMLDocumentPart
- Throws:
PartAlreadyExistsException- If rule M1.12 is not verified : Packages shall not contain equivalent part names and package implementers shall neither create nor recognize packages with equivalent part names.
-
createRelationship
public final POIXMLDocumentPart createRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx) Create a new child POIXMLDocumentPart- Parameters:
descriptor- the part descriptorfactory- the factory that will create an instance of the requested relationidx- part number- Returns:
- the created child POIXMLDocumentPart
- Throws:
PartAlreadyExistsException- If rule M1.12 is not verified : Packages shall not contain equivalent part names and package implementers shall neither create nor recognize packages with equivalent part names.
-
getNextPartNumber
Identifies the next available part number for a part of the given type, if possible, otherwise -1 if none are available. The found (valid) index can then be safely given tocreateRelationship(POIXMLRelation, POIXMLFactory, int)orcreateRelationship(POIXMLRelation, POIXMLFactory, int, boolean)without naming clashes. If parts with other types are already claiming a name for this relationship type (eg aXSSFRelation.CHARTusing the drawing part namespace normally used byXSSFRelation.DRAWINGS), those will be considered when finding the next spare number.- Parameters:
descriptor- The relationship type to find the part number forminIdx- The minimum free index to assign, use -1 for any- Returns:
- The next free part number, or -1 if none available
-
createRelationship
public final POIXMLDocumentPart.RelationPart createRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx, boolean noRelation) Create a new child POIXMLDocumentPart- Parameters:
descriptor- the part descriptorfactory- the factory that will create an instance of the requested relationidx- part numbernoRelation- if true, then no relationship is added.- Returns:
- the created child POIXMLDocumentPart
- Throws:
PartAlreadyExistsException- If rule M1.12 is not verified : Packages shall not contain equivalent part names and package implementers shall neither create nor recognize packages with equivalent part names.
-
read
protected void read(POIXMLFactory factory, Map<PackagePart, POIXMLDocumentPart> context) throws OpenXML4JExceptionIterate through the underlying PackagePart and create child POIXMLFactory instances using the specified factory- Parameters:
factory- the factory object that creates POIXMLFactory instancescontext- context map containing already visited noted keyed by targetURI- Throws:
OpenXML4JException- thrown when a related part can't be read
-
getTargetPart
Get the PackagePart that is the target of a relationship from this Part.- Parameters:
rel- The relationship- Returns:
- The target part
- Throws:
InvalidFormatException- thrown if the related part has is erroneous
-
onDocumentCreate
Fired when a new package part is created- Throws:
IOException- a subclass may throw an IOException on document creation
-
onDocumentRead
Fired when a package part is read- Throws:
IOException- a subclass may throw an IOException when a document is read
-
onDocumentRemove
Fired when a package part is about to be removed from the package- Throws:
IOException- a subclass may throw an IOException when a document is removed
-
_invokeOnDocumentRead
@Internal @Deprecated public static void _invokeOnDocumentRead(POIXMLDocumentPart part) throws IOException Deprecated.Internal method, do not use!This method only exists to allow access to protected
onDocumentRead()fromXWPFDocumentwithout reflection. It should be removed.- Parameters:
part- the part which is to be read- Throws:
IOException- if the part can't be read
-