public abstract class POIDocument extends Object
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
POIDocument() |
Modifier and Type | Method and Description |
---|---|
private void |
copyNodeRecursively(Entry entry,
DirectoryEntry target)
Copies an Entry into a target POIFS directory, recursively
|
protected void |
copyNodes(POIFSFileSystem source,
POIFSFileSystem target,
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(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
|
private boolean |
isInList(String entry,
List list)
Checks to see if the String is in the list, used when copying
nodes between one POIFS and another
|
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,
List writtenEntries)
Writes out the standard Documment Information Properties (HPSF)
|
protected void |
writePropertySet(String name,
PropertySet set,
POIFSFileSystem outFS)
Writes out a given ProperySet
|
protected SummaryInformation sInf
protected DocumentSummaryInformation dsInf
protected POIFSFileSystem filesystem
protected POILogger logger
public DocumentSummaryInformation getDocumentSummaryInformation()
public SummaryInformation getSummaryInformation()
protected void readProperties()
protected PropertySet getPropertySet(String setName)
protected void writeProperties(POIFSFileSystem outFS) throws IOException
outFS
- the POIFSFileSystem to write the properties intoIOException
protected void writeProperties(POIFSFileSystem outFS, List writtenEntries) throws IOException
outFS
- the POIFSFileSystem to write the properties intowrittenEntries
- a list of POIFS entries to add the property names tooIOException
protected void writePropertySet(String name, PropertySet set, POIFSFileSystem outFS) throws IOException
name
- the (POIFS Level) name of the property to writeset
- the PropertySet to write outoutFS
- the POIFSFileSystem to write the property intoIOException
protected void copyNodes(POIFSFileSystem source, POIFSFileSystem target, List excepts) throws 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 copyIOException
private boolean isInList(String entry, List list)
private void copyNodeRecursively(Entry entry, DirectoryEntry target) throws IOException
IOException
Copyright © 2016 Open Microscopy Environment