|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.POIXMLProperties
public class POIXMLProperties
Wrapper around the three different kinds of OOXML properties and metadata a document can have (Core, Extended and Custom), as well Thumbnails.
| Nested Class Summary | |
|---|---|
static class |
POIXMLProperties.CoreProperties
The core document properties |
static class |
POIXMLProperties.CustomProperties
Custom document properties |
static class |
POIXMLProperties.ExtendedProperties
Extended document properties |
| Constructor Summary | |
|---|---|
POIXMLProperties(OPCPackage docPackage)
|
|
| Method Summary | |
|---|---|
void |
commit()
Commit changes to the underlying OPC package |
POIXMLProperties.CoreProperties |
getCoreProperties()
Returns the core document properties |
POIXMLProperties.CustomProperties |
getCustomProperties()
Returns the custom document properties |
POIXMLProperties.ExtendedProperties |
getExtendedProperties()
Returns the extended document properties |
java.lang.String |
getThumbnailFilename()
Returns the name of the Document thumbnail, eg thumbnail.jpeg, or null if there
isn't one. |
java.io.InputStream |
getThumbnailImage()
Returns the Document thumbnail image data, or null if there isn't one. |
protected PackagePart |
getThumbnailPart()
Returns the PackagePart for the Document
Thumbnail, or null if there isn't one |
void |
setThumbnail(java.lang.String filename,
java.io.InputStream imageData)
Sets the Thumbnail for the document, replacing any existing one. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public POIXMLProperties(OPCPackage docPackage)
throws java.io.IOException,
OpenXML4JException,
org.apache.xmlbeans.XmlException
java.io.IOException
OpenXML4JException
org.apache.xmlbeans.XmlException| Method Detail |
|---|
public POIXMLProperties.CoreProperties getCoreProperties()
public POIXMLProperties.ExtendedProperties getExtendedProperties()
public POIXMLProperties.CustomProperties getCustomProperties()
protected PackagePart getThumbnailPart()
PackagePart for the Document
Thumbnail, or null if there isn't one
public java.lang.String getThumbnailFilename()
thumbnail.jpeg, or null if there
isn't one.
public java.io.InputStream getThumbnailImage()
throws java.io.IOException
null if there isn't one.
java.io.IOException - if the thumbnail can't be read
public void setThumbnail(java.lang.String filename,
java.io.InputStream imageData)
throws java.io.IOException
filename - The filename for the thumbnail image, eg thumbnail.jpgimageData - The inputstream to read the thumbnail image from
java.io.IOException - if the thumbnail can't be written
public void commit()
throws java.io.IOException
java.io.IOException - if the properties can't be saved
POIXMLException - if the properties are erroneous
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||