|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.POIXMLDocumentPart
public class POIXMLDocumentPart
Represents an entry of a OOXML package.
Each POIXMLDocumentPart keeps a reference to the underlying a PackagePart
.
Nested Class Summary | |
---|---|
static class |
POIXMLDocumentPart.RelationPart
The RelationPart is a cached relationship between the document, which contains the RelationPart, and one of its referenced child document parts. |
Constructor Summary | |
---|---|
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(OPCPackage pkg,
java.lang.String coreDocumentRel)
Construct POIXMLDocumentPart representing a custom "core document" package part. |
|
POIXMLDocumentPart(PackagePart part)
Creates an POIXMLDocumentPart representing the given package part and relationship. |
|
POIXMLDocumentPart(PackagePart part,
PackageRelationship rel)
Deprecated. in POI 3.14, scheduled for removal in POI 3.16 |
|
POIXMLDocumentPart(POIXMLDocumentPart parent,
PackagePart part)
Creates an POIXMLDocumentPart representing the given package part, relationship and parent Called by read(POIXMLFactory, java.util.Map) when reading in an existing file. |
|
POIXMLDocumentPart(POIXMLDocumentPart parent,
PackagePart part,
PackageRelationship rel)
Deprecated. in POI 3.14, scheduled for removal in POI 3.16 |
Method Summary | |
---|---|
static void |
_invokeOnDocumentRead(POIXMLDocumentPart part)
Deprecated. |
void |
addRelation(java.lang.String id,
POIXMLDocumentPart part)
Deprecated. in POI 3.14, scheduled for removal in POI 3.16 |
POIXMLDocumentPart.RelationPart |
addRelation(java.lang.String relId,
POIXMLRelation relationshipType,
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)
Create a new child POIXMLDocumentPart |
protected POIXMLDocumentPart.RelationPart |
createRelationship(POIXMLRelation descriptor,
POIXMLFactory factory,
int idx,
boolean noRelation)
Create a new child POIXMLDocumentPart |
PackagePart |
getPackagePart()
Provides access to the underlying PackagePart |
PackageRelationship |
getPackageRelationship()
Deprecated. in POI 3.14, scheduled for removal in POI 3.16 |
POIXMLDocumentPart |
getParent()
Returns the parent POIXMLDocumentPart. |
POIXMLDocumentPart |
getRelationById(java.lang.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. |
java.lang.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. |
java.util.List<POIXMLDocumentPart.RelationPart> |
getRelationParts()
Returns the list of child relations for this POIXMLDocumentPart |
java.util.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(java.util.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,
java.util.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. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public POIXMLDocumentPart(OPCPackage pkg)
public POIXMLDocumentPart(OPCPackage pkg, java.lang.String coreDocumentRel)
public POIXMLDocumentPart()
createRelationship(POIXMLRelation, POIXMLFactory, int, boolean)
public POIXMLDocumentPart(PackagePart part)
read(POIXMLFactory, java.util.Map)
when reading in an existing file.
part
- - The package part that holds xml data representing this sheet.read(POIXMLFactory, java.util.Map)
public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part)
read(POIXMLFactory, java.util.Map)
when reading in an existing file.
parent
- - Parent partpart
- - The package part that holds xml data representing this sheet.read(POIXMLFactory, java.util.Map)
@Deprecated public POIXMLDocumentPart(PackagePart part, PackageRelationship rel)
read(POIXMLFactory, java.util.Map)
when reading in an existing file.
part
- - The package part that holds xml data representing this sheet.rel
- - the relationship of the given package partread(POIXMLFactory, java.util.Map)
@Deprecated public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part, PackageRelationship rel)
read(POIXMLFactory, java.util.Map)
when reading in an exisiting file.
parent
- - Parent partpart
- - The package part that holds xml data represenring this sheet.rel
- - the relationship of the given package partread(POIXMLFactory, java.util.Map)
Method Detail |
---|
protected final void rebase(OPCPackage pkg) throws InvalidFormatException
InvalidFormatException
public final PackagePart getPackagePart()
@Deprecated public final PackageRelationship getPackageRelationship()
public final java.util.List<POIXMLDocumentPart> getRelations()
public final java.util.List<POIXMLDocumentPart.RelationPart> getRelationParts()
public final POIXMLDocumentPart getRelationById(java.lang.String id)
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.
id
- The relation id to look for
public final java.lang.String getRelationId(POIXMLDocumentPart part)
PackageRelationship.getId()
of the
PackageRelationship
, that sources from the PackagePart
of
this POIXMLDocumentPart
to the PackagePart
of the given
parameter value.
part
- The POIXMLDocumentPart
for which the according
relation-id shall be found.
PackageRelationship.getId()
or null, if
parts are not related.@Deprecated public final void addRelation(java.lang.String id, POIXMLDocumentPart part)
part
- the child to addpublic final POIXMLDocumentPart.RelationPart addRelation(java.lang.String relId, POIXMLRelation relationshipType, POIXMLDocumentPart part)
relId
- the preferred relation id, when null the next free relation id will be usedrelationshipType
- the package relationship typepart
- the child to addprotected final void removeRelation(POIXMLDocumentPart part)
protected final boolean removeRelation(POIXMLDocumentPart part, boolean removeUnusedParts)
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.public final POIXMLDocumentPart getParent()
null
for the root element.public java.lang.String toString()
toString
in class java.lang.Object
protected void commit() throws java.io.IOException
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();
}
java.io.IOException
protected final void onSave(java.util.Set<PackagePart> alreadySaved) throws java.io.IOException
commit()
for each package part
alreadySaved
- context set containing already visited nodes
java.io.IOException
protected void prepareForCommit()
public final POIXMLDocumentPart createRelationship(POIXMLRelation descriptor, POIXMLFactory factory)
descriptor
- the part descriptorfactory
- the factory that will create an instance of the requested relation
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.public final POIXMLDocumentPart createRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx)
descriptor
- the part descriptorfactory
- the factory that will create an instance of the requested relationidx
- part number
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.protected final POIXMLDocumentPart.RelationPart createRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx, boolean noRelation)
descriptor
- the part descriptorfactory
- the factory that will create an instance of the requested relationidx
- part numbernoRelation
- if true, then no relationship is added.
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.protected void read(POIXMLFactory factory, java.util.Map<PackagePart,POIXMLDocumentPart> context) throws OpenXML4JException
factory
- the factory object that creates POIXMLFactory instancescontext
- context map containing already visited noted keyed by targetURI
OpenXML4JException
protected PackagePart getTargetPart(PackageRelationship rel) throws InvalidFormatException
rel
- The relationship
InvalidFormatException
protected void onDocumentCreate() throws java.io.IOException
java.io.IOException
protected void onDocumentRead() throws java.io.IOException
java.io.IOException
protected void onDocumentRemove() throws java.io.IOException
java.io.IOException
@Internal @Deprecated public static void _invokeOnDocumentRead(POIXMLDocumentPart part) throws java.io.IOException
This method only exists to allow access to protected onDocumentRead()
from XWPFDocument
without reflection. It should be removed.
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |