Class SummaryInformation
- java.lang.Object
-
- loci.poi.hpsf.PropertySet
-
- loci.poi.hpsf.MutablePropertySet
-
- loci.poi.hpsf.SpecialPropertySet
-
- loci.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 496419 2007-01-15 17:56:52Z klute $
- Author:
- Rainer Klute <klute@rainer-klute.de>
- See Also:
DocumentSummaryInformation
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_STREAM_NAME
The document name a summary information stream usually has in a POIFS filesystem.-
Fields inherited from class loci.poi.hpsf.PropertySet
byteOrder, classID, format, OS_MACINTOSH, OS_WIN16, OS_WIN32, osVersion, sections
-
-
Constructor Summary
Constructors Constructor Description SummaryInformation(PropertySet ps)
Creates aSummaryInformation
from a givenPropertySet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getApplicationName()
Returns the application name (ornull
).String
getAuthor()
Returns the author (ornull
).int
getCharCount()
Returns the character count or 0 if theSummaryInformation
does not contain a char count.String
getComments()
Returns the comments (ornull
).Date
getCreateDateTime()
Returns the creation time (ornull
).long
getEditTime()
Returns the total time spent in editing the document (or0
).String
getKeywords()
Returns the keywords (ornull
).String
getLastAuthor()
Returns the last author (ornull
).Date
getLastPrinted()
Returns the last printed time (ornull
).Date
getLastSaveDateTime()
Returns the last save time (ornull
).int
getPageCount()
Returns the page count or 0 if theSummaryInformation
does not contain a page count.String
getRevNumber()
Returns the revision number (ornull
).int
getSecurity()
Returns a security code which is one of the following values:String
getSubject()
Returns the subject (ornull
).String
getTemplate()
Returns the template (ornull
).byte[]
getThumbnail()
Returns the thumbnail (ornull
) when this method is implemented.String
getTitle()
Returns the title (ornull
).int
getWordCount()
Returns the word count or 0 if theSummaryInformation
does not contain a word count.void
removeApplicationName()
Removes the application name.void
removeAuthor()
Removes the author.void
removeCharCount()
Removes the character count.void
removeComments()
Removes the comments.void
removeCreateDateTime()
Removes the creation time.void
removeEditTime()
Remove the total time spent in editing the document.void
removeKeywords()
Removes the keywords.void
removeLastAuthor()
Removes the last author.void
removeLastPrinted()
Removes the lastPrinted.void
removeLastSaveDateTime()
Remove the total time spent in editing the document.void
removePageCount()
Removes the page count.void
removeRevNumber()
Removes the revision number.void
removeSecurity()
Removes the security code.void
removeSubject()
Removes the subject.void
removeTemplate()
Removes the template.void
removeThumbnail()
Removes the thumbnail.void
removeTitle()
Removes the title.void
removeWordCount()
Removes the word count.void
setApplicationName(String applicationName)
Sets the application name.void
setAuthor(String author)
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
setTitle(String title)
Sets the title.void
setWordCount(int wordCount)
Sets the word count.-
Methods inherited from class loci.poi.hpsf.SpecialPropertySet
addSection, clearSections, equals, getByteOrder, getClassID, getFirstSection, getFormat, getOSVersion, getProperties, getProperty, getPropertyBooleanValue, getPropertyIntValue, getSectionCount, getSections, hashCode, isDocumentSummaryInformation, isSummaryInformation, setByteOrder, setClassID, setFormat, setOSVersion, toInputStream, toString, wasNull, write, write
-
Methods inherited from class loci.poi.hpsf.PropertySet
getSingleSection, isPropertySetStream, isPropertySetStream
-
-
-
-
Field Detail
-
DEFAULT_STREAM_NAME
public static final String DEFAULT_STREAM_NAME
The document name a summary information stream usually has in a POIFS filesystem.
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SummaryInformation
public SummaryInformation(PropertySet ps) throws UnexpectedPropertySetTypeException
Creates a
SummaryInformation
from a givenPropertySet
.- 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 String getTitle()
Returns the title (or
null
).- Returns:
- The title or
null
-
setTitle
public void setTitle(String title)
Sets the title.
- Parameters:
title
- The title to set.
-
removeTitle
public void removeTitle()
Removes the title.
-
getSubject
public String getSubject()
Returns the subject (or
null
).- Returns:
- The subject or
null
-
setSubject
public void setSubject(String subject)
Sets the subject.
- Parameters:
subject
- The subject to set.
-
removeSubject
public void removeSubject()
Removes the subject.
-
getAuthor
public String getAuthor()
Returns the author (or
null
).- Returns:
- The author or
null
-
setAuthor
public void setAuthor(String author)
Sets the author.
- Parameters:
author
- The author to set.
-
removeAuthor
public void removeAuthor()
Removes the author.
-
getKeywords
public String getKeywords()
Returns the keywords (or
null
).- Returns:
- The keywords or
null
-
setKeywords
public void setKeywords(String keywords)
Sets the keywords.
- Parameters:
keywords
- The keywords to set.
-
removeKeywords
public void removeKeywords()
Removes the keywords.
-
getComments
public String getComments()
Returns the comments (or
null
).- Returns:
- The comments or
null
-
setComments
public void setComments(String comments)
Sets the comments.
- Parameters:
comments
- The comments to set.
-
removeComments
public void removeComments()
Removes the comments.
-
getTemplate
public String getTemplate()
Returns the template (or
null
).- Returns:
- The template or
null
-
setTemplate
public void setTemplate(String template)
Sets the template.
- Parameters:
template
- The template to set.
-
removeTemplate
public void removeTemplate()
Removes the template.
-
getLastAuthor
public String getLastAuthor()
Returns the last author (or
null
).- Returns:
- The last author or
null
-
setLastAuthor
public void setLastAuthor(String lastAuthor)
Sets the last author.
- Parameters:
lastAuthor
- The last author to set.
-
removeLastAuthor
public void removeLastAuthor()
Removes the last author.
-
getRevNumber
public String getRevNumber()
Returns the revision number (or
null
).- Returns:
- The revision number or
null
-
setRevNumber
public void setRevNumber(String revNumber)
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 (or
0
).- 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
public Date getLastPrinted()
Returns the last printed time (or
null
).- Returns:
- The last printed time or
null
-
setLastPrinted
public void setLastPrinted(Date lastPrinted)
Sets the lastPrinted.
- Parameters:
lastPrinted
- The lastPrinted to set.
-
removeLastPrinted
public void removeLastPrinted()
Removes the lastPrinted.
-
getCreateDateTime
public Date getCreateDateTime()
Returns the creation time (or
null
).- Returns:
- The creation time or
null
-
setCreateDateTime
public void setCreateDateTime(Date createDateTime)
Sets the creation time.
- Parameters:
createDateTime
- The creation time to set.
-
removeCreateDateTime
public void removeCreateDateTime()
Removes the creation time.
-
getLastSaveDateTime
public Date getLastSaveDateTime()
Returns the last save time (or
null
).- Returns:
- The last save time or
null
-
setLastSaveDateTime
public void setLastSaveDateTime(Date time)
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 the
SummaryInformation
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 the
SummaryInformation
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 the
SummaryInformation
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 (or
null
) when this method is implemented. Please note that the return type is likely to change!Hint to developers: Drew Varner <Drew.Varner -at- sc.edu> said that this is an image in WMF or Clipboard (BMP?) format. However, we won't do any conversion into any image type but instead just return a byte array.
- 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
public String getApplicationName()
Returns the application name (or
null
).- Returns:
- The application name or
null
-
setApplicationName
public void setApplicationName(String applicationName)
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
-
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.
-
-