org.apache.poi.hpsf
Class SummaryInformation

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

public class SummaryInformation

extends SpecialPropertySet

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

Since:

2002-02-09

Version:

$Id: SummaryInformation.java,v 1.1 2002/02/14 04:00:59 mjohnson Exp $

Author:

Rainer Klute (klute@rainer-klute.de)

See Also:

DocumentSummaryInformation

Constructor Summary

SummaryInformation(PropertySet ps)
Creates a SummaryInformation from a given PropertySet.

Method Summary

java.lang.String	getApplicationName() Returns the stream's application name (or null).
java.lang.String	getAuthor() Returns the stream's author (or null).
int	getCharCount() Returns the stream's char count or 0 if the SummaryInformation does not contain a char count.
java.lang.String	getComments() Returns the stream's comments (or null).
java.util.Date	getCreateDateTime() Returns the stream's creation time (or null).
java.util.Date	getEditTime() Returns the stream's edit time (or null).
java.lang.String	getKeywords() Returns the stream's keywords (or null).
java.lang.String	getLastAuthor() Returns the stream's last author (or null).
java.util.Date	getLastPrinted() Returns the stream's last printed time (or null).
java.util.Date	getLastSaveDateTime() Returns the stream's last save time (or null).
int	getPageCount() Returns the stream's page count or 0 if the SummaryInformation does not contain a page count.
java.lang.String	getRevNumber() Returns the stream's revision number (or null).
int	getSecurity() Returns the stream's security field or 0 if the SummaryInformation does not contain a security field.
java.lang.String	getSubject() Returns the stream's subject (or null).
java.lang.String	getTemplate() Returns the stream's template (or null).
byte[]	getThumbnail() Returns the stream's thumbnail (or null) when this method is implemented.
java.lang.String	getTitle() Returns the stream's title (or null).
int	getWordCount() Returns the stream's word count or 0 if the SummaryInformation does not contain a word 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

SummaryInformation

public SummaryInformation(PropertySet ps)
                   throws UnexpectedPropertySetTypeException

Creates a SummaryInformation from a given PropertySet.

Parameters:

ps - A property set which should be created from a summary information stream.

Throws:

UnexpectedPropertySetTypeException - if ps does not contain a summary information stream.

Method Detail

getTitle

public java.lang.String getTitle()

Returns the stream's title (or null).

getSubject

public java.lang.String getSubject()

Returns the stream's subject (or null).

getAuthor

public java.lang.String getAuthor()

Returns the stream's author (or null).

getKeywords

public java.lang.String getKeywords()

Returns the stream's keywords (or null).

getComments

public java.lang.String getComments()

Returns the stream's comments (or null).

getTemplate

public java.lang.String getTemplate()

Returns the stream's template (or null).

getLastAuthor

public java.lang.String getLastAuthor()

Returns the stream's last author (or null).

getRevNumber

public java.lang.String getRevNumber()

Returns the stream's revision number (or null).

getEditTime

public java.util.Date getEditTime()

Returns the stream's edit time (or null).

getLastPrinted

public java.util.Date getLastPrinted()

Returns the stream's last printed time (or null).

getCreateDateTime

public java.util.Date getCreateDateTime()

Returns the stream's creation time (or null).

getLastSaveDateTime

public java.util.Date getLastSaveDateTime()

Returns the stream's last save time (or null).

getPageCount

public int getPageCount()

Returns the stream's page count or 0 if the SummaryInformation does not contain a page count.

getWordCount

public int getWordCount()

Returns the stream's word count or 0 if the SummaryInformation does not contain a word count.

getCharCount

public int getCharCount()

Returns the stream's char count or 0 if the SummaryInformation does not contain a char count.

getThumbnail

public byte[] getThumbnail()

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

getApplicationName

public java.lang.String getApplicationName()

Returns the stream's application name (or null).

getSecurity

public int getSecurity()

Returns the stream's security field or 0 if the SummaryInformation does not contain a security field.