org.apache.poi

Class POIDocument

java.lang.Object

org.apache.poi.POIDocument

Direct Known Subclasses:

HPSFPropertiesOnlyDocument, HSSFWorkbook

public abstract class POIDocument
extends java.lang.Object

This holds the common functionality for all POI Document classes. Currently, this relates to Document Information Properties

Method Summary

Modifier and Type	Method and Description
void	createInformationProperties() Will create whichever of SummaryInformation and DocumentSummaryInformation (HPSF) properties are not already part of your document.
DocumentSummaryInformation	getDocumentSummaryInformation() Fetch the Document Summary Information of the document
SummaryInformation	getSummaryInformation() Fetch the Summary Information of the document
abstract void	write(java.io.OutputStream out) Writes the document out to the specified output stream.

Methods inherited from class java.lang.Object

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

Method Detail

getDocumentSummaryInformation

public DocumentSummaryInformation getDocumentSummaryInformation()

Fetch the Document Summary Information of the document

Returns:

The Document Summary Information or null if it could not be read for this document.

getSummaryInformation

public SummaryInformation getSummaryInformation()

Fetch the Summary Information of the document

Returns:

The Summary information for the document or null if it could not be read for this document.

createInformationProperties

public void createInformationProperties()

Will create whichever of SummaryInformation and DocumentSummaryInformation (HPSF) properties are not already part of your document. This is normally useful when creating a new document from scratch. If the information properties are already there, then nothing will happen.

write

public abstract void write(java.io.OutputStream out)
                    throws java.io.IOException

Writes the document out to the specified output stream. The stream is not closed as part of this operation.

Parameters:

out - The stream to write to.

Throws:

java.io.IOException - thrown on errors writing to the stream