org.apache.poi.hpsf
Class DocumentSummaryInformation

java.lang.Object
  |
  +--org.apache.poi.hpsf.PropertySet
        |
        +--org.apache.poi.hpsf.SpecialPropertySet
              |
              +--org.apache.poi.hpsf.DocumentSummaryInformation

public class DocumentSummaryInformation
extends SpecialPropertySet

Convenience class representing a DocumentSummary Information stream in a Microsoft Office document.

Since:
2002-02-09
Version:
$Id$
Author:
Rainer Klute (klute@rainer-klute.de)
See Also:
SummaryInformation

Constructor Summary
DocumentSummaryInformation(PropertySet ps)
          Creates a DocumentSummaryInformation from a given PropertySet.
 
Method Summary
 int getByteCount()
          Returns the stream's byte count or 0 if the DocumentSummaryInformation does not contain a byte count.
 java.lang.String getCategory()
          Returns the stream's category (or null).
 java.lang.String getCompany()
          Returns the stream's company (or null).
 byte[] getDocparts()
          Returns the stream's doc parts (or null) when this method is implemented.
 byte[] getHeadingPair()
          Returns the stream's heading pair (or null) when this method is implemented.
 int getHiddenCount()
          Returns the stream's hidden count or 0 if the DocumentSummaryInformation does not contain a hidden count.
 int getLineCount()
          Returns the stream's line count or 0 if the DocumentSummaryInformation does not contain a line count.
 byte[] getLinksDirty()
          Returns the stream's links dirty (or null) when this method is implemented.
 java.lang.String getManager()
          Returns the stream's manager (or null).
 int getMMClipCount()
          Returns the stream's mmclip count or 0 if the DocumentSummaryInformation does not contain a mmclip count.
 int getNoteCount()
          Returns the stream's note count or 0 if the DocumentSummaryInformation does not contain a note count.
 int getParCount()
          Returns the stream's par count or 0 if the DocumentSummaryInformation does not contain a par count.
 java.lang.String getPresentationFormat()
          Returns the stream's presentation format (or null).
 byte[] getScale()
          Returns the stream's scale (or null) when this method is implemented.
 int getSlideCount()
          Returns the stream's slide count or 0 if the DocumentSummaryInformation does not contain a slide count.
 
Methods inherited from class org.apache.poi.hpsf.SpecialPropertySet
getByteOrder, getClassID, getFormat, getOSVersion, getSectionCount, getSections, getSingleSection, isDocumentSummaryInformation, isSummaryInformation
 
Methods inherited from class org.apache.poi.hpsf.PropertySet
getProperties, getProperty, getPropertyIntValue, isPropertySetStream, isPropertySetStream, wasNull
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DocumentSummaryInformation

public DocumentSummaryInformation(PropertySet ps)
                           throws UnexpectedPropertySetTypeException

Creates a DocumentSummaryInformation from a given PropertySet.

Parameters:
ps - A property set which should be created from a document summary information stream.
Throws:
UnexpectedPropertySetTypeException - if ps does not contain a document summary information stream.
Method Detail

getCategory

public java.lang.String getCategory()

Returns the stream's category (or null).


getPresentationFormat

public java.lang.String getPresentationFormat()

Returns the stream's presentation format (or null).


getByteCount

public int getByteCount()

Returns the stream's byte count or 0 if the DocumentSummaryInformation does not contain a byte count.


getLineCount

public int getLineCount()

Returns the stream's line count or 0 if the DocumentSummaryInformation does not contain a line count.


getParCount

public int getParCount()

Returns the stream's par count or 0 if the DocumentSummaryInformation does not contain a par count.


getSlideCount

public int getSlideCount()

Returns the stream's slide count or 0 if the DocumentSummaryInformation does not contain a slide count.


getNoteCount

public int getNoteCount()

Returns the stream's note count or 0 if the DocumentSummaryInformation does not contain a note count.


getHiddenCount

public int getHiddenCount()

Returns the stream's hidden count or 0 if the DocumentSummaryInformation does not contain a hidden count.


getMMClipCount

public int getMMClipCount()

Returns the stream's mmclip count or 0 if the DocumentSummaryInformation does not contain a mmclip count.


getScale

public byte[] getScale()

Returns the stream's scale (or null) when this method is implemented. Please note that the return type is likely to change!


getHeadingPair

public byte[] getHeadingPair()

Returns the stream's heading pair (or null) when this method is implemented. Please note that the return type is likely to change!


getDocparts

public byte[] getDocparts()

Returns the stream's doc parts (or null) when this method is implemented. Please note that the return type is likely to change!


getManager

public java.lang.String getManager()

Returns the stream's manager (or null).


getCompany

public java.lang.String getCompany()

Returns the stream's company (or null).


getLinksDirty

public byte[] getLinksDirty()

Returns the stream's links dirty (or null) when this method is implemented. Please note that the return type is likely to change!



Copyright © 2001-2002 JAKARTA POI project. All Rights Reserved.