Package org.apache.poi.hpsf
Class SummaryInformation
java.lang.Object
org.apache.poi.hpsf.PropertySet
org.apache.poi.hpsf.SummaryInformation
Convenience class representing a Summary Information stream in a
Microsoft Office document.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The document name a summary information stream usually has in a POIFS filesystem.static final ClassID
The SummaryInformation's section's format ID.Fields inherited from class org.apache.poi.hpsf.PropertySet
OS_MACINTOSH, OS_WIN16, OS_WIN32
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an emptySummaryInformation
.SummaryInformation
(InputStream stream) Creates aSummaryInformation
instance from anInputStream
in the Horrible Property Set Format.Creates aSummaryInformation
from a givenPropertySet
. -
Method Summary
Modifier and TypeMethodDescriptionReturns the application name (ornull
).Returns the author (ornull
).int
Returns the character count or 0 if theSummaryInformation
does not contain a char count.Returns the comments (ornull
).Returns the creation time (ornull
).long
Returns the total time spent in editing the document (or0
).Returns the keywords (ornull
).Returns the last author (ornull
).Returns the last printed time (ornull
).Returns the last save time (ornull
).int
Returns the page count or 0 if theSummaryInformation
does not contain a page count.The id to name mapping of the properties in this set.Returns the revision number (ornull
).int
Returns a security code which is one of the following values: 0 if theSummaryInformation
does not contain a security field or if there is no security on the document.Returns the subject (ornull
).Returns the template (ornull
).byte[]
Returns the thumbnail (ornull
) when this method is implemented.Returns the thumbnail (ornull
), processed as an object which is (largely) able to unpack the thumbnail image data.getTitle()
int
Returns the word count or 0 if theSummaryInformation
does not contain a word count.void
Removes the application name.void
Removes the author.void
Removes the character count.void
Removes the comments.void
Removes the creation time.void
Remove the total time spent in editing the document.void
Removes the keywords.void
Removes the last author.void
Removes the lastPrinted.void
Remove the total time spent in editing the document.void
Removes the page count.void
Removes the revision number.void
Removes the security code.void
Removes the subject.void
Removes the template.void
Removes the thumbnail.void
Removes the title.void
Removes the word count.void
setApplicationName
(String applicationName) Sets the application name.void
Sets the author.void
setCharCount
(int charCount) Sets the character count.void
setComments
(String comments) Sets the comments.void
setCreateDateTime
(Date createDateTime) Sets the creation time.void
setEditTime
(long time) Sets the total time spent in editing the document.void
setKeywords
(String keywords) Sets the keywords.void
setLastAuthor
(String lastAuthor) Sets the last author.void
setLastPrinted
(Date lastPrinted) Sets the lastPrinted.void
setLastSaveDateTime
(Date time) Sets the total time spent in editing the document.void
setPageCount
(int pageCount) Sets the page count.void
setRevNumber
(String revNumber) Sets the revision number.void
setSecurity
(int security) Sets the security code.void
setSubject
(String subject) Sets the subject.void
setTemplate
(String template) Sets the template.void
setThumbnail
(byte[] thumbnail) Sets the thumbnail.void
Sets the title.void
setWordCount
(int wordCount) Sets the word count.Methods inherited from class org.apache.poi.hpsf.PropertySet
addSection, clearSections, equals, getByteOrder, getClassID, getFirstSection, getFormat, getOSVersion, getProperties, getProperty, getPropertyStringValue, getSectionCount, getSections, getSingleSection, hashCode, isDocumentSummaryInformation, isPropertySetStream, isPropertySetStream, isSummaryInformation, setByteOrder, setClassID, setFormat, setOSVersion, toInputStream, toString, wasNull, write, write
-
Field Details
-
DEFAULT_STREAM_NAME
The document name a summary information stream usually has in a POIFS filesystem.- See Also:
-
FORMAT_ID
The SummaryInformation's section's format ID.
-
-
Constructor Details
-
SummaryInformation
public SummaryInformation()Creates an emptySummaryInformation
. -
SummaryInformation
Creates aSummaryInformation
from a givenPropertySet
.- Parameters:
ps
- A property set which should be created from a summary information stream.- Throws:
UnexpectedPropertySetTypeException
- ifps
does not contain a summary information stream.
-
SummaryInformation
public SummaryInformation(InputStream stream) throws NoPropertySetStreamException, MarkUnsupportedException, IOException, UnsupportedEncodingException Creates aSummaryInformation
instance from anInputStream
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. If it is, it parses the rest of the stream. If it is not, it resets the stream to its beginning in order to let other components mess around with the data and throws an exception.
- Parameters:
stream
- Holds the data making out the property set stream.- Throws:
MarkUnsupportedException
- if the stream does not support theInputStream.markSupported()
method.IOException
- if theInputStream
cannot be accessed as needed.NoPropertySetStreamException
- if the input stream does not contain a property set.UnsupportedEncodingException
- if a character encoding is not supported.
-
-
Method Details
-
getPropertySetIDMap
Description copied from class:PropertySet
The id to name mapping of the properties in this set.- Overrides:
getPropertySetIDMap
in classPropertySet
- Returns:
- the id to name mapping of the properties in this set or
null
if not applicable
-
getTitle
- Returns:
- The title or
null
-
setTitle
Sets the title.- Parameters:
title
- The title to set.
-
removeTitle
public void removeTitle()Removes the title. -
getSubject
Returns the subject (ornull
).- Returns:
- The subject or
null
-
setSubject
Sets the subject.- Parameters:
subject
- The subject to set.
-
removeSubject
public void removeSubject()Removes the subject. -
getAuthor
Returns the author (ornull
).- Returns:
- The author or
null
-
setAuthor
Sets the author.- Parameters:
author
- The author to set.
-
removeAuthor
public void removeAuthor()Removes the author. -
getKeywords
Returns the keywords (ornull
).- Returns:
- The keywords or
null
-
setKeywords
Sets the keywords.- Parameters:
keywords
- The keywords to set.
-
removeKeywords
public void removeKeywords()Removes the keywords. -
getComments
Returns the comments (ornull
).- Returns:
- The comments or
null
-
setComments
Sets the comments.- Parameters:
comments
- The comments to set.
-
removeComments
public void removeComments()Removes the comments. -
getTemplate
Returns the template (ornull
).- Returns:
- The template or
null
-
setTemplate
Sets the template.- Parameters:
template
- The template to set.
-
removeTemplate
public void removeTemplate()Removes the template. -
getLastAuthor
Returns the last author (ornull
).- Returns:
- The last author or
null
-
setLastAuthor
Sets the last author.- Parameters:
lastAuthor
- The last author to set.
-
removeLastAuthor
public void removeLastAuthor()Removes the last author. -
getRevNumber
Returns the revision number (ornull
).- Returns:
- The revision number or
null
-
setRevNumber
Sets the revision number.- Parameters:
revNumber
- The revision number to set.
-
removeRevNumber
public void removeRevNumber()Removes the revision number. -
getEditTime
public long getEditTime()Returns the total time spent in editing the document (or0
).- Returns:
- The total time spent in editing the document or 0 if the
SummaryInformation
does not contain this information.
-
setEditTime
public void setEditTime(long time) Sets the total time spent in editing the document.- Parameters:
time
- The time to set.
-
removeEditTime
public void removeEditTime()Remove the total time spent in editing the document. -
getLastPrinted
Returns the last printed time (ornull
).- Returns:
- The last printed time or
null
-
setLastPrinted
Sets the lastPrinted.- Parameters:
lastPrinted
- The lastPrinted to set.
-
removeLastPrinted
public void removeLastPrinted()Removes the lastPrinted. -
getCreateDateTime
Returns the creation time (ornull
).- Returns:
- The creation time or
null
-
setCreateDateTime
Sets the creation time.- Parameters:
createDateTime
- The creation time to set.
-
removeCreateDateTime
public void removeCreateDateTime()Removes the creation time. -
getLastSaveDateTime
Returns the last save time (ornull
).- Returns:
- The last save time or
null
-
setLastSaveDateTime
Sets the total time spent in editing the document.- Parameters:
time
- The time to set.
-
removeLastSaveDateTime
public void removeLastSaveDateTime()Remove the total time spent in editing the document. -
getPageCount
public int getPageCount()Returns the page count or 0 if theSummaryInformation
does not contain a page count.- Returns:
- The page count or 0 if the
SummaryInformation
does not contain a page count.
-
setPageCount
public void setPageCount(int pageCount) Sets the page count.- Parameters:
pageCount
- The page count to set.
-
removePageCount
public void removePageCount()Removes the page count. -
getWordCount
public int getWordCount()Returns the word count or 0 if theSummaryInformation
does not contain a word count.- Returns:
- The word count or
null
-
setWordCount
public void setWordCount(int wordCount) Sets the word count.- Parameters:
wordCount
- The word count to set.
-
removeWordCount
public void removeWordCount()Removes the word count. -
getCharCount
public int getCharCount()Returns the character count or 0 if theSummaryInformation
does not contain a char count.- Returns:
- The character count or
null
-
setCharCount
public void setCharCount(int charCount) Sets the character count.- Parameters:
charCount
- The character count to set.
-
removeCharCount
public void removeCharCount()Removes the character count. -
getThumbnail
public byte[] getThumbnail()Returns the thumbnail (ornull
) when this method is implemented. Please note that the return type is likely to change!To process this data, you may wish to make use of the
Thumbnail
class. The raw data is generally an image in WMF or Clipboard (BMP?) format- Returns:
- The thumbnail or
null
-
getThumbnailThumbnail
Returns the thumbnail (ornull
), processed as an object which is (largely) able to unpack the thumbnail image data.- Returns:
- The thumbnail or
null
-
setThumbnail
public void setThumbnail(byte[] thumbnail) Sets the thumbnail.- Parameters:
thumbnail
- The thumbnail to set.
-
removeThumbnail
public void removeThumbnail()Removes the thumbnail. -
getApplicationName
Returns the application name (ornull
).- Returns:
- The application name or
null
-
setApplicationName
Sets the application name.- Parameters:
applicationName
- The application name to set.
-
removeApplicationName
public void removeApplicationName()Removes the application name. -
getSecurity
public int getSecurity()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. UsePropertySet.wasNull()
to distinguish between the two cases! - 1 if the document is password protected
- 2 if the document is read-only recommended
- 4 if the document is read-only enforced
- 8 if the document is locked for annotations
- Returns:
- The security code or
null
- 0 if the
-
setSecurity
public void setSecurity(int security) Sets the security code.- Parameters:
security
- The security code to set.
-
removeSecurity
public void removeSecurity()Removes the security code.
-