Package org.apache.poi.ooxml

Class POIXMLDocumentPart

java.lang.Object
org.apache.poi.ooxml.POIXMLDocumentPart
Direct Known Subclasses:
CalculationChain, CommentsTable, ExternalLinksTable, MapInfo, POIXMLDocument, SharedStringsTable, SingleXmlCells, StylesTable, ThemesTable, org.apache.poi.xddf.usermodel.chart.XDDFChart, XDGFXMLDocumentPart, XSLFCommentAuthors, XSLFComments, XSLFDiagramDrawing, XSLFFontData, XSLFObjectData, XSLFPictureData, XSLFSheet, XSLFTableStyles, XSLFTheme, XSSFDrawing, XSSFPictureData, XSSFPivotCache, XSSFPivotCacheDefinition, XSSFPivotCacheRecords, XSSFPivotTable, XSSFSheet, XSSFTable, XSSFVBAPart, XSSFVMLDrawing, XWPFAbstractFootnotesEndnotes, XWPFComments, 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.

  • Constructor Details

    • POIXMLDocumentPart

      public POIXMLDocumentPart(OPCPackage pkg)
      Construct POIXMLDocumentPart representing a "core document" package part.
      Parameters:
      pkg - the OPCPackage containing this document

    • POIXMLDocumentPart

      public POIXMLDocumentPart(OPCPackage pkg, String coreDocumentRel)
      Construct POIXMLDocumentPart representing a custom "core document" package part.
      Parameters:
      pkg - the OPCPackage containing this document
      coreDocumentRel - the relation type of this document

    • POIXMLDocumentPart

      public POIXMLDocumentPart()
      Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.
      See Also:

    • POIXMLDocumentPart

      public POIXMLDocumentPart(PackagePart part)
      Creates an POIXMLDocumentPart representing the given package part and relationship. Called by read(POIXMLFactory, 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:
      • read(POIXMLFactory, Map)

    • POIXMLDocumentPart

      public POIXMLDocumentPart(POIXMLDocumentPart parent, PackagePart part)
      Creates an POIXMLDocumentPart representing the given package part, relationship and parent Called by read(POIXMLFactory, Map) when reading in an existing file.
      Parameters:
      parent - - Parent part
      part - - The package part that holds xml data representing this sheet.
      Since:
      POI 3.14-Beta1
      See Also:
      • read(POIXMLFactory, Map)

  • Method Details

    • isCommitted

      public boolean isCommitted()
      to check whether embedded part is already committed
      Returns:
      return true if embedded part is committed
      Since:
      4.1.2

    • setCommitted

      public void setCommitted(boolean isCommitted)
      setter method to set embedded part is committed
      Parameters:
      isCommitted - boolean value

    • getPackagePart

      public final PackagePart getPackagePart()
      Provides access to the underlying PackagePart
      Returns:
      the underlying PackagePart

    • getRelations

      public final List<POIXMLDocumentPart> getRelations()
      Returns the list of child relations for this POIXMLDocumentPart
      Returns:
      child relations

    • getRelationParts

      public final List<POIXMLDocumentPart.RelationPart> getRelationParts()
      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

    • getRelationPartById

      public final POIXMLDocumentPart.RelationPart getRelationPartById(String id)
      Returns the target POIXMLDocumentPart.RelationPart, 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 relation part, or null, if none exists
      Since:
      4.0.0

    • getRelationId

      public final String getRelationId(POIXMLDocumentPart part)
      Returns the first PackageRelationship.getId() of the PackageRelationship, that sources from the PackagePart of this POIXMLDocumentPart to the PackagePart of the given parameter value.

      There can be multiple references to the given POIXMLDocumentPart and only the first in the order of creation is returned.

      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 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 used
      relationshipType - the package relationship type
      part - the child to add
      Returns:
      the new RelationPart
      Since:
      3.14-Beta1

    • 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

    • 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
      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 descriptor
      factory - the factory that will create an instance of the requested relation
      idx - 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

      @Internal public final int getNextPartNumber(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. The found (valid) index can then be safely given to createRelationship(POIXMLRelation, POIXMLFactory, int) or createRelationship(POIXMLRelation, POIXMLFactory, int, boolean) without naming clashes. If parts with other types are already claiming a name for this relationship type (eg a XSSFRelation.CHART using the drawing part namespace normally used by XSSFRelation.DRAWINGS), those will be considered when finding the next spare number.
      Parameters:
      descriptor - The relationship type to find the part number for
      minIdx - 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 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
      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.

    • _invokeOnDocumentRead

      @Internal @Deprecated public static void _invokeOnDocumentRead(POIXMLDocumentPart part) throws IOException
      Deprecated.
      This method only exists to allow access to protected onDocumentRead() from XWPFDocument without reflection. It should be removed.
      Internal method, do not use!
      Parameters:
      part - the part which is to be read
      Throws:
      IOException - if the part can't be read