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 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 Summary

Constructors

Constructor and Description
POIDocument()

Method Summary

Methods

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

POIDocument

public POIDocument()

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 into

writtenEntries - 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 write

set - the PropertySet to write out

outFS - 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 from

target - is the target POIFS to copy to

excepts - is a list of Strings specifying what nodes NOT to copy

Throws:

IOException

isInList

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

copyNodeRecursively

private void copyNodeRecursively(Entry entry,
                       DirectoryEntry target)
                          throws IOException

Copies an Entry into a target POIFS directory, recursively

Throws:

IOException