|
||||||||||
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
.
Field Summary | |
---|---|
static org.apache.xmlbeans.XmlOptions |
DEFAULT_XML_OPTIONS
|
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(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 | |
---|---|
void |
addRelation(java.lang.String id,
POIXMLDocumentPart part)
Add a new child POIXMLDocumentPart |
POIXMLDocumentPart |
createRelationship(POIXMLRelation descriptor,
POIXMLFactory factory)
Create a new child POIXMLDocumentPart |
POIXMLDocumentPart |
createRelationship(POIXMLRelation descriptor,
POIXMLFactory factory,
int idx)
|
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(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 |
getRelations()
Returns the list of child relations for this POIXMLDocumentPart |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final org.apache.xmlbeans.XmlOptions DEFAULT_XML_OPTIONS
Constructor Detail |
---|
public POIXMLDocumentPart(OPCPackage pkg)
public POIXMLDocumentPart()
createRelationship(POIXMLRelation, POIXMLFactory, int, boolean)
public POIXMLDocumentPart(PackagePart part, PackageRelationship rel)
read(POIXMLFactory, java.util.Map)
when reading in an exisiting file.
part
- - The package part that holds xml data represenring this sheet.rel
- - the relationship of the given package partread(POIXMLFactory, java.util.Map)
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 |
---|
public final PackagePart getPackagePart()
public final PackageRelationship getPackageRelationship()
public final java.util.List getRelations()
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.public final void addRelation(java.lang.String id, POIXMLDocumentPart part)
part
- the child to addpublic final POIXMLDocumentPart getParent()
null
for the root element.public java.lang.String toString()
toString
in class java.lang.Object
public final POIXMLDocumentPart createRelationship(POIXMLRelation descriptor, POIXMLFactory factory)
descriptor
- the part descriptorfactory
- the factory that will create an instance of the requested relation
public final POIXMLDocumentPart createRelationship(POIXMLRelation descriptor, POIXMLFactory factory, int idx)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |