Package loci.poi
Class POIDocument
java.lang.Object
loci.poi.POIDocument
- Direct Known Subclasses:
HSSFWorkbook
This holds the common functionality for all POI
Document classes.
Currently, this relates to Document Information Properties
- Author:
- Nick Burch
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected DocumentSummaryInformationHolds further metadata on our documentprotected POIFSFileSystemThe open POIFS FileSystem that contains our documentprotected POILoggerFor our own logging useprotected SummaryInformationHolds metadata on our document -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcopyNodes(POIFSFileSystem source, POIFSFileSystem target, List excepts) Copies nodes from one POIFS to the other minus the exceptsFetch the Document Summary Information of the documentprotected PropertySetgetPropertySet(String setName) For a given named property entry, either return it or null if if it wasn't foundFetch the Summary Information of the documentprotected voidFind, and create objects for, the standard Documment Information Properties (HPSF)protected voidwriteProperties(POIFSFileSystem outFS) Writes out the standard Documment Information Properties (HPSF)protected voidwriteProperties(POIFSFileSystem outFS, List writtenEntries) Writes out the standard Documment Information Properties (HPSF)protected voidwritePropertySet(String name, PropertySet set, POIFSFileSystem outFS) Writes out a given ProperySet
-
Field Details
-
sInf
Holds metadata on our document -
dsInf
Holds further metadata on our document -
filesystem
The open POIFS FileSystem that contains our document -
logger
For our own logging use
-
-
Constructor Details
-
POIDocument
public POIDocument()
-
-
Method Details
-
getDocumentSummaryInformation
Fetch the Document Summary Information of the document -
getSummaryInformation
Fetch the Summary Information of the document -
readProperties
protected void readProperties()Find, and create objects for, the standard Documment Information Properties (HPSF) -
getPropertySet
For a given named property entry, either return it or null if if it wasn't found -
writeProperties
Writes out the standard Documment Information Properties (HPSF)- Parameters:
outFS- the POIFSFileSystem to write the properties into- Throws:
IOException
-
writeProperties
Writes out the standard Documment Information Properties (HPSF)- Parameters:
outFS- the POIFSFileSystem to write the properties intowrittenEntries- a list of POIFS entries to add the property names too- Throws:
IOException
-
writePropertySet
protected void writePropertySet(String name, PropertySet set, POIFSFileSystem outFS) throws IOException Writes out a given ProperySet- Parameters:
name- the (POIFS Level) name of the property to writeset- the PropertySet to write outoutFS- the POIFSFileSystem to write the property into- Throws:
IOException
-
copyNodes
protected void copyNodes(POIFSFileSystem source, POIFSFileSystem target, List excepts) throws IOException Copies nodes from one POIFS to the other minus the excepts- Parameters:
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- Throws:
IOException
-