|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.POIDocument
public abstract class POIDocument
This holds the common functionality for all POI Document classes. Currently, this relates to Document Information Properties
Field Summary | |
---|---|
protected DocumentSummaryInformation |
dsInf
Holds further metadata on our document |
protected POIFSFileSystem |
filesystem
The open POIFS FileSystem that contains our document |
protected POILogger |
logger
For our own logging use |
protected SummaryInformation |
sInf
Holds metadata on our document |
Constructor Summary | |
---|---|
POIDocument()
|
Method Summary | |
---|---|
protected void |
copyNodes(POIFSFileSystem source,
POIFSFileSystem target,
java.util.List excepts)
Copies nodes from one POIFS to the other minus the excepts |
DocumentSummaryInformation |
getDocumentSummaryInformation()
Fetch the Document Summary Information of the document |
protected PropertySet |
getPropertySet(java.lang.String setName)
For a given named property entry, either return it or null if if it wasn't found |
SummaryInformation |
getSummaryInformation()
Fetch the Summary Information of the document |
protected void |
readProperties()
Find, and create objects for, the standard Documment Information Properties (HPSF) |
protected void |
writeProperties(POIFSFileSystem outFS)
Writes out the standard Documment Information Properties (HPSF) |
protected void |
writeProperties(POIFSFileSystem outFS,
java.util.List writtenEntries)
Writes out the standard Documment Information Properties (HPSF) |
protected void |
writePropertySet(java.lang.String name,
PropertySet set,
POIFSFileSystem outFS)
Writes out a given ProperySet |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected SummaryInformation sInf
protected DocumentSummaryInformation dsInf
protected POIFSFileSystem filesystem
protected POILogger logger
Constructor Detail |
---|
public POIDocument()
Method Detail |
---|
public DocumentSummaryInformation getDocumentSummaryInformation()
public SummaryInformation getSummaryInformation()
protected void readProperties()
protected PropertySet getPropertySet(java.lang.String setName)
protected void writeProperties(POIFSFileSystem outFS) throws java.io.IOException
outFS
- the POIFSFileSystem to write the properties into
java.io.IOException
protected void writeProperties(POIFSFileSystem outFS, java.util.List writtenEntries) throws java.io.IOException
outFS
- the POIFSFileSystem to write the properties intowrittenEntries
- a list of POIFS entries to add the property names too
java.io.IOException
protected void writePropertySet(java.lang.String name, PropertySet set, POIFSFileSystem outFS) throws java.io.IOException
name
- the (POIFS Level) name of the property to writeset
- the PropertySet to write outoutFS
- the POIFSFileSystem to write the property into
java.io.IOException
protected void copyNodes(POIFSFileSystem source, POIFSFileSystem target, java.util.List excepts) throws java.io.IOException
source
- is the source POIFS to copy fromtarget
- is the target POIFS to copy toexcepts
- is a list of Strings specifying what nodes NOT to copy
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |