org.apache.poi

Class POIXMLDocument

java.lang.Object

org.apache.poi.POIXMLDocumentPart

org.apache.poi.POIXMLDocument

Direct Known Subclasses:

XMLSlideShow, XSLFSlideShow, XSSFWorkbook, XWPFDocument

public abstract class POIXMLDocument
extends POIXMLDocumentPart

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_CREATOR
static String	OLE_OBJECT_REL_TYPE
static String	PACK_OBJECT_REL_TYPE

Fields inherited from class org.apache.poi.POIXMLDocumentPart

DEFAULT_XML_OPTIONS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	POIXMLDocument(OPCPackage pkg)

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<PackagePart>	getAllEmbedds() Get the document's embedded files.
protected PackagePart	getCorePart()
OPCPackage	getPackage()
POIXMLProperties	getProperties() Get the document properties.
protected PackagePart[]	getRelatedByType(String contentType) Retrieves all the PackageParts which are defined as relationships of the base document with the specified content type.
static boolean	hasOOXMLHeader(InputStream inp) 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.
protected void	load(POIXMLFactory factory)
static OPCPackage	openPackage(String path) Wrapper to open a package, returning an IOException in the event of a problem.
void	write(OutputStream stream) Write out this document to an Outputstream.

Methods inherited from class org.apache.poi.POIXMLDocumentPart

addRelation, commit, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelations, getTargetPart, onDocumentCreate, onDocumentRead, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DOCUMENT_CREATOR

public static final String DOCUMENT_CREATOR

See Also:

Constant Field Values

OLE_OBJECT_REL_TYPE

public static final String OLE_OBJECT_REL_TYPE

See Also:

Constant Field Values

PACK_OBJECT_REL_TYPE

public static final String PACK_OBJECT_REL_TYPE

See Also:

Constant Field Values

Constructor Detail

POIXMLDocument

protected POIXMLDocument(OPCPackage pkg)

Method Detail

openPackage

public static OPCPackage openPackage(String path)
                              throws IOException

Wrapper to open a package, returning an IOException in the event of a problem. Works around shortcomings in java's this() constructor calls

Throws:

IOException

getPackage

public OPCPackage getPackage()

getCorePart

protected PackagePart getCorePart()

getRelatedByType

protected PackagePart[] getRelatedByType(String contentType)
                                  throws InvalidFormatException

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

Throws:

InvalidFormatException

hasOOXMLHeader

public static boolean hasOOXMLHeader(InputStream inp)
                              throws IOException

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

Throws:

IOException

getProperties

public POIXMLProperties getProperties()

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

getAllEmbedds

public abstract List<PackagePart> getAllEmbedds()
                                         throws OpenXML4JException

Get the document's embedded files.

Throws:

OpenXML4JException

load

protected final void load(POIXMLFactory factory)
                   throws IOException

Throws:

IOException

write

public final void write(OutputStream stream)
                 throws IOException

Write out this document to an Outputstream.

Parameters:

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

Throws:

IOException - if anything can't be written.