|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hpsf.PropertySet | +--org.apache.poi.hpsf.SpecialPropertySet | +--org.apache.poi.hpsf.SummaryInformation
Convenience class representing a Summary Information stream in a Microsoft Office document.
See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/com/stgu_8910.asp for documentation from That Redmond Company.
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 one of the following values: |
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, getPropertyBooleanValue, getPropertyIntValue, isPropertySetStream, isPropertySetStream, wasNull |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public SummaryInformation(PropertySet ps) throws UnexpectedPropertySetTypeException
Creates a SummaryInformation
from a given PropertySet
.
ps
- A property set which
should be created from a summary information stream.
UnexpectedPropertySetTypeException
- Description of the
ExceptionMethod Detail |
public java.lang.String getTitle()
Returns the stream's title (or null
).
public java.lang.String getSubject()
Returns the stream's subject (or null
).
public java.lang.String getAuthor()
Returns the stream's author (or null
).
public java.lang.String getKeywords()
Returns the stream's keywords (or null
).
public java.lang.String getComments()
Returns the stream's comments (or null
).
public java.lang.String getTemplate()
Returns the stream's template (or null
).
public java.lang.String getLastAuthor()
Returns the stream's last author (or null
).
public java.lang.String getRevNumber()
Returns the stream's revision number (or null
).
public java.util.Date getEditTime()
Returns the stream's edit time (or null
).
public java.util.Date getLastPrinted()
Returns the stream's last printed time (or null
).
public java.util.Date getCreateDateTime()
Returns the stream's creation time (or null
).
public java.util.Date getLastSaveDateTime()
Returns the stream's last save time (or null
).
public int getPageCount()
Returns the stream's page count or 0 if the SummaryInformation
does not contain a page count.
public int getWordCount()
Returns the stream's word count or 0 if the SummaryInformation
does not contain a word count.
public int getCharCount()
Returns the stream's char count or 0 if the SummaryInformation
does not contain a char count.
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!
FIXME / Hint to developers: Drew Varner <Drew.Varner -at- sc.edu> said that this is an image in WMF or Clipboard (BMP?) format. He also provided two links that might be helpful: http://www.csn.ul.ie/~caolan/publink/file/OLE2SummaryAgainst_file-3.27.patch and http://msdn.microsoft.com/library/en-us/dno97ta/html/msdn_docprop.asp . However, we won't do any conversion into any image type but instead just return a byte array.
public java.lang.String getApplicationName()
Returns the stream's application name (or null
).
public int getSecurity()
Returns one of the following values:
0 if the SummaryInformation
does not contain a security field
or if there is no security on the document. Use PropertySet.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
|
jakarta-poi 1.8.0-dev | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |