|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.POIXMLDocumentPart
org.apache.poi.POIXMLDocument
public abstract class POIXMLDocument
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.poi.POIXMLDocumentPart |
---|
POIXMLDocumentPart.RelationPart |
Field Summary | |
---|---|
static java.lang.String |
DOCUMENT_CREATOR
|
static java.lang.String |
OLE_OBJECT_REL_TYPE
|
static java.lang.String |
PACK_OBJECT_REL_TYPE
|
Constructor Summary | |
---|---|
protected |
POIXMLDocument(OPCPackage pkg)
|
protected |
POIXMLDocument(OPCPackage pkg,
java.lang.String coreDocumentRel)
|
Method Summary | |
---|---|
void |
close()
Closes the underlying OPCPackage from which this
document was read, if there is one |
abstract java.util.List<PackagePart> |
getAllEmbedds()
Get the document's embedded files. |
protected PackagePart |
getCorePart()
|
OPCPackage |
getPackage()
|
POIXMLProperties |
getProperties()
Get the document properties. |
protected PackagePart[] |
getRelatedByType(java.lang.String contentType)
Retrieves all the PackageParts which are defined as relationships of the base document with the specified content type. |
static boolean |
hasOOXMLHeader(java.io.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(java.lang.String path)
Wrapper to open a package, returning an IOException in the event of a problem. |
void |
write(java.io.OutputStream stream)
Write out this document to an Outputstream. |
Methods inherited from class org.apache.poi.POIXMLDocumentPart |
---|
_invokeOnDocumentRead, addRelation, addRelation, commit, createRelationship, createRelationship, createRelationship, getPackagePart, getPackageRelationship, getParent, getRelationById, getRelationId, getRelationParts, 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 |
---|
public static final java.lang.String DOCUMENT_CREATOR
public static final java.lang.String OLE_OBJECT_REL_TYPE
public static final java.lang.String PACK_OBJECT_REL_TYPE
Constructor Detail |
---|
protected POIXMLDocument(OPCPackage pkg)
protected POIXMLDocument(OPCPackage pkg, java.lang.String coreDocumentRel)
Method Detail |
---|
public static OPCPackage openPackage(java.lang.String path) throws java.io.IOException
java.io.IOException
public OPCPackage getPackage()
protected PackagePart getCorePart()
protected PackagePart[] getRelatedByType(java.lang.String contentType) throws InvalidFormatException
InvalidFormatException
public static boolean hasOOXMLHeader(java.io.InputStream inp) throws java.io.IOException
inp
- An InputStream which supports either mark/reset, or is a PushbackInputStream
java.io.IOException
public POIXMLProperties getProperties()
public abstract java.util.List<PackagePart> getAllEmbedds() throws OpenXML4JException
OpenXML4JException
protected final void load(POIXMLFactory factory) throws java.io.IOException
java.io.IOException
public void close() throws java.io.IOException
OPCPackage
from which this
document was read, if there is one
close
in interface java.io.Closeable
java.io.IOException
public final void write(java.io.OutputStream stream) throws java.io.IOException
File
rather
than an InputStream
, you must write out to
a different file, overwriting via an OutputStream isn't possible.
stream
- - the java OutputStream you wish to write the file to
java.io.IOException
- if anything can't be written.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |