Field Detail

• DOCUMENT_CREATOR

  public static final java.lang.String DOCUMENT_CREATOR

  See Also:

  Constant Field Values

• OLE_OBJECT_REL_TYPE

  public static final java.lang.String OLE_OBJECT_REL_TYPE

  See Also:

  Constant Field Values

• PACK_OBJECT_REL_TYPE

  public static final java.lang.String PACK_OBJECT_REL_TYPE

  See Also:

  Constant Field Values

Constructor Detail

• POIXMLDocument

  protected POIXMLDocument(OPCPackage pkg)

• POIXMLDocument

  protected POIXMLDocument(OPCPackage pkg,
                java.lang.String coreDocumentRel)

Method Detail

• openPackage

  public static OPCPackage openPackage(java.lang.String path)
                                throws java.io.IOException

  Wrapper to open a package, which works around shortcomings in java's this() constructor calls

  Parameters:

  path - the path to the document

  Returns:

  the new OPCPackage

  Throws:

  java.io.IOException - if there was a problem opening the document

• getPackage

  public OPCPackage getPackage()

  Get the assigned OPCPackage

  Returns:

  the assigned OPCPackage

• getCorePart

  protected PackagePart getCorePart()

• getRelatedByType

  protected PackagePart[] getRelatedByType(java.lang.String contentType)
                                    throws InvalidFormatException

  Retrieves all the PackageParts which are defined as relationships of the base document with the specified content type.

  Parameters:

  contentType - the content type

  Returns:

  all the base document PackageParts which match the content type

  Throws:

  InvalidFormatException - when the relationships or the parts contain errors

  See Also:

  XSSFRelation, XSLFRelation, XWPFRelation, XDGFRelation

• hasOOXMLHeader

  @Deprecated
  public static boolean hasOOXMLHeader(java.io.InputStream inp)
                                throws java.io.IOException

  Deprecated. use the method from DocumentFactoryHelper, deprecated as of 3.15-beta1, therefore eligible for removal in 3.17
  Checks that the supplied InputStream (which MUST support mark and reset, or be a PushbackInputStream) has a OOXML (zip) header at the start of it. If your InputStream does not support mark / reset, then wrap it in a PushBackInputStream, then be sure to always use that, and not the original!

  Parameters:

  inp - An InputStream which supports either mark/reset, or is a PushbackInputStream

  Returns:

  true, if the InputStream is an ooxml document

  Throws:

  java.io.IOException - if the InputStream can't be read

• getProperties

  public POIXMLProperties getProperties()

  Get the document properties. This gives you access to the core ooxml properties, and the extended ooxml properties.

  Returns:

  the document properties

• getAllEmbedds

  public abstract java.util.List<PackagePart> getAllEmbedds()
                                                     throws OpenXML4JException

  Get the document's embedded files.

  Returns:

  the document's embedded files

  Throws:

  OpenXML4JException - if the embedded parts can't be determined

• load

  protected final void load(POIXMLFactory factory)
                     throws java.io.IOException

  Throws:

  java.io.IOException

• close

  public void close()
             throws java.io.IOException

  Closes the underlying OPCPackage from which this document was read, if there is one

  Once this has been called, no further operations, updates or reads should be performed on the document.

  Specified by:

  close in interface java.io.Closeable

  Throws:

  java.io.IOException - for writable packages, if an IO exception occur during the saving process.

• write

  public final void write(java.io.OutputStream stream)
                   throws java.io.IOException

  Write out this document to an Outputstream. Note - if the Document was opened from a File rather than an InputStream, you must write out to a different file, overwriting via an OutputStream isn't possible. If stream is a FileOutputStream on a networked drive or has a high cost/latency associated with each written byte, consider wrapping the OutputStream in a BufferedOutputStream to improve write performance.

  Parameters:

  stream - - the java OutputStream you wish to write the file to

  Throws:

  java.io.IOException - if anything can't be written.