org.apache.poi
Class POIDocument

java.lang.Object
  extended by org.apache.poi.POIDocument
Direct Known Subclasses:
HSLFSlideShow, HWPFDocument

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

Author:
Nick Burch

Field Summary
protected  DocumentSummaryInformation dsInf
           
protected  POIFSFileSystem filesystem
           
protected  SummaryInformation sInf
           
 
Constructor Summary
POIDocument()
           
 
Method Summary
 DocumentSummaryInformation getDocumentSummaryInformation()
          Fetch the Document Summary Information of the document
protected  PropertySet getPropertySet(java.lang.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
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 writePropertySet(java.lang.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

dsInf

protected DocumentSummaryInformation dsInf

filesystem

protected POIFSFileSystem filesystem
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(java.lang.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 java.io.IOException
Writes out the standard Documment Information Properties (HPSF)

Parameters:
outFS - the POIFSFileSystem to write the properties into
Throws:
java.io.IOException

writePropertySet

protected void writePropertySet(java.lang.String name,
                                PropertySet set,
                                POIFSFileSystem outFS)
                         throws java.io.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:
java.io.IOException


Copyright 2006 The Apache Software Foundation or its licensors, as applicable.