Java org.apache.poi.hpsf SummaryInformation fields, constructors, methods, implement or subclass

Example usage for Java org.apache.poi.hpsf SummaryInformation fields, constructors, methods, implement or subclass

Introduction

In this page you can find the methods, fields and constructors for org.apache.poi.hpsf SummaryInformation.

The text is from its open source code.

Field

StringDEFAULT_STREAM_NAME
The document name a summary information stream usually has in a POIFS filesystem.

Constructor

SummaryInformation(final PropertySet ps)
Creates a SummaryInformation from a given PropertySet .
SummaryInformation(final InputStream stream)
Creates a SummaryInformation instance from an InputStream in the Horrible Property Set Format.

The constructor reads the first few bytes from the stream and determines whether it is really a property set stream.

Method

StringgetApplicationName()
Returns the application name (or null ).
StringgetAuthor()
Returns the author (or null ).
intgetCharCount()
Returns the character count or 0 if the SummaryInformation does not contain a char count.
StringgetComments()
Returns the comments (or null ).
DategetCreateDateTime()
Returns the creation time (or null ).
longgetEditTime()
Returns the total time spent in editing the document (or 0 ).
StringgetKeywords()
Returns the keywords (or null ).
StringgetLastAuthor()
Returns the last author (or null ).
DategetLastPrinted()
Returns the last printed time (or null ).
DategetLastSaveDateTime()
Returns the last save time (or null ).
intgetOSVersion()
intgetPageCount()
Returns the page count or 0 if the SummaryInformation does not contain a page count.
StringgetRevNumber()
Returns the revision number (or null ).
intgetSecurity()
Returns a security code which is one of the following values:
  • 0 if the SummaryInformation does not contain a security field or if there is no security on the document.
StringgetSubject()
Returns the subject (or null ).
StringgetTemplate()
Returns the template (or null ).
byte[]getThumbnail()
Returns the thumbnail (or null ) when this method is implemented.
StringgetTitle()
intgetWordCount()
Returns the word count or 0 if the SummaryInformation does not contain a word count.
voidsetApplicationName(final String applicationName)
Sets the application name.
voidsetAuthor(final String author)
Sets the author.
voidsetComments(final String comments)
Sets the comments.
voidsetCreateDateTime(final Date createDateTime)
Sets the creation time.
voidsetKeywords(final String keywords)
Sets the keywords.
voidsetLastAuthor(final String lastAuthor)
Sets the last author.
voidsetRevNumber(final String revNumber)
Sets the revision number.
voidsetSubject(final String subject)
Sets the subject.
voidsetTitle(final String title)
Sets the title.
booleanwasNull()
Checks whether the property which the last call to #getPropertyIntValue or #getProperty tried to access was available or not.
voidwrite(final DirectoryEntry dir, final String name)
Writes a property set to a document in a POI filesystem directory.