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 Details

  • Constructor Details

    • POIDocument

      public POIDocument()
  • Method Details

    • 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