Package loci.poi
Class POIDocument
- java.lang.Object
-
- loci.poi.POIDocument
-
- Direct Known Subclasses:
HSSFWorkbook
public abstract class POIDocument extends Object
This holds the common functionality for all POI Document classes. Currently, this relates to Document Information Properties- Author:
- Nick Burch
-
-
Field Summary
Fields Modifier and Type Field Description protected DocumentSummaryInformation
dsInf
Holds further metadata on our documentprotected POIFSFileSystem
filesystem
The open POIFS FileSystem that contains our documentprotected POILogger
logger
For our own logging useprotected SummaryInformation
sInf
Holds metadata on our document
-
Constructor Summary
Constructors Constructor Description POIDocument()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
copyNodes(POIFSFileSystem source, POIFSFileSystem target, List excepts)
Copies nodes from one POIFS to the other minus the exceptsDocumentSummaryInformation
getDocumentSummaryInformation()
Fetch the Document Summary Information of the documentprotected PropertySet
getPropertySet(String setName)
For a given named property entry, either return it or null if if it wasn't foundSummaryInformation
getSummaryInformation()
Fetch the Summary Information of the documentprotected 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, List writtenEntries)
Writes out the standard Documment Information Properties (HPSF)protected void
writePropertySet(String name, PropertySet set, POIFSFileSystem outFS)
Writes out a given ProperySet
-
-
-
Field Detail
-
sInf
protected SummaryInformation sInf
Holds metadata on our document
-
dsInf
protected DocumentSummaryInformation dsInf
Holds further metadata on our document
-
filesystem
protected POIFSFileSystem filesystem
The open POIFS FileSystem that contains our document
-
logger
protected POILogger logger
For our own logging use
-
-
Method Detail
-
getDocumentSummaryInformation
public DocumentSummaryInformation getDocumentSummaryInformation()
Fetch the Document Summary Information of the document
-
getSummaryInformation
public SummaryInformation getSummaryInformation()
Fetch the Summary Information of the document
-
readProperties
protected void readProperties()
Find, and create objects for, the standard Documment Information Properties (HPSF)
-
getPropertySet
protected PropertySet getPropertySet(String setName)
For a given named property entry, either return it or null if if it wasn't found
-
writeProperties
protected void writeProperties(POIFSFileSystem outFS) throws IOException
Writes out the standard Documment Information Properties (HPSF)- Parameters:
outFS
- the POIFSFileSystem to write the properties into- Throws:
IOException
-
writeProperties
protected void writeProperties(POIFSFileSystem outFS, List writtenEntries) throws IOException
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
-
-