Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hpsf » [javadoc | source]
org.apache.poi.hpsf
public class: SummaryInformation [javadoc | source]
java.lang.Object
   org.apache.poi.hpsf.PropertySet
      org.apache.poi.hpsf.MutablePropertySet
         org.apache.poi.hpsf.SpecialPropertySet
            org.apache.poi.hpsf.SummaryInformation

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

Field Summary
public static final  String DEFAULT_STREAM_NAME   

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

 
Fields inherited from org.apache.poi.hpsf.PropertySet:
BYTE_ORDER_ASSERTION,  byteOrder,  FORMAT_ASSERTION,  format,  osVersion,  OS_WIN16,  OS_MACINTOSH,  OS_WIN32,  classID,  sections
Constructor:
 public SummaryInformation(PropertySet ps) throws UnexpectedPropertySetTypeException 
    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 from org.apache.poi.hpsf.SummaryInformation Summary:
getApplicationName,   getAuthor,   getCharCount,   getComments,   getCreateDateTime,   getEditTime,   getKeywords,   getLastAuthor,   getLastPrinted,   getLastSaveDateTime,   getPageCount,   getRevNumber,   getSecurity,   getSubject,   getTemplate,   getThumbnail,   getTitle,   getWordCount,   removeApplicationName,   removeAuthor,   removeCharCount,   removeComments,   removeCreateDateTime,   removeEditTime,   removeKeywords,   removeLastAuthor,   removeLastPrinted,   removeLastSaveDateTime,   removePageCount,   removeRevNumber,   removeSecurity,   removeSubject,   removeTemplate,   removeThumbnail,   removeTitle,   removeWordCount,   setApplicationName,   setAuthor,   setCharCount,   setComments,   setCreateDateTime,   setEditTime,   setKeywords,   setLastAuthor,   setLastPrinted,   setLastSaveDateTime,   setPageCount,   setRevNumber,   setSecurity,   setSubject,   setTemplate,   setThumbnail,   setTitle,   setWordCount
Methods from org.apache.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 from org.apache.poi.hpsf.MutablePropertySet:
addSection,   clearSections,   setByteOrder,   setClassID,   setFormat,   setOSVersion,   toInputStream,   write,   write
Methods from org.apache.poi.hpsf.PropertySet:
equals,   getByteOrder,   getClassID,   getFirstSection,   getFormat,   getOSVersion,   getProperties,   getProperty,   getPropertyBooleanValue,   getPropertyIntValue,   getSectionCount,   getSections,   getSingleSection,   hashCode,   isDocumentSummaryInformation,   isPropertySetStream,   isPropertySetStream,   isSummaryInformation,   toString,   wasNull
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.poi.hpsf.SummaryInformation Detail:
 public String getApplicationName() 

    Returns the application name (or null).

 public String getAuthor() 

    Returns the author (or null).

 public int getCharCount() 
 public String getComments() 

    Returns the comments (or null).

 public Date getCreateDateTime() 

    Returns the creation time (or null).

 public long getEditTime() 

    Returns the total time spent in editing the document (or 0).

 public String getKeywords() 

    Returns the keywords (or null).

 public String getLastAuthor() 

    Returns the last author (or null).

 public Date getLastPrinted() 

    Returns the last printed time (or null).

 public Date getLastSaveDateTime() 

    Returns the last save time (or null).

 public int getPageCount() 
 public String getRevNumber() 

    Returns the revision number (or null).

 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. 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

 public String getSubject() 

    Returns the subject (or null).

 public String getTemplate() 

    Returns the template (or null).

 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.

 public String getTitle() 

    Returns the title (or null).

 public int getWordCount() 
 public  void removeApplicationName() 

    Removes the application name.

 public  void removeAuthor() 

    Removes the author.

 public  void removeCharCount() 

    Removes the character count.

 public  void removeComments() 

    Removes the comments.

 public  void removeCreateDateTime() 

    Removes the creation time.

 public  void removeEditTime() 

    Remove the total time spent in editing the document.

 public  void removeKeywords() 

    Removes the keywords.

 public  void removeLastAuthor() 

    Removes the last author.

 public  void removeLastPrinted() 

    Removes the lastPrinted.

 public  void removeLastSaveDateTime() 

    Remove the total time spent in editing the document.

 public  void removePageCount() 

    Removes the page count.

 public  void removeRevNumber() 

    Removes the revision number.

 public  void removeSecurity() 

    Removes the security code.

 public  void removeSubject() 

    Removes the subject.

 public  void removeTemplate() 

    Removes the template.

 public  void removeThumbnail() 

    Removes the thumbnail.

 public  void removeTitle() 

    Removes the title.

 public  void removeWordCount() 

    Removes the word count.

 public  void setApplicationName(String applicationName) 

    Sets the application name.

 public  void setAuthor(String author) 

    Sets the author.

 public  void setCharCount(int charCount) 

    Sets the character count.

 public  void setComments(String comments) 

    Sets the comments.

 public  void setCreateDateTime(Date createDateTime) 

    Sets the creation time.

 public  void setEditTime(long time) 

    Sets the total time spent in editing the document.

 public  void setKeywords(String keywords) 

    Sets the keywords.

 public  void setLastAuthor(String lastAuthor) 

    Sets the last author.

 public  void setLastPrinted(Date lastPrinted) 

    Sets the lastPrinted.

 public  void setLastSaveDateTime(Date time) 

    Sets the total time spent in editing the document.

 public  void setPageCount(int pageCount) 

    Sets the page count.

 public  void setRevNumber(String revNumber) 

    Sets the revision number.

 public  void setSecurity(int security) 

    Sets the security code.

 public  void setSubject(String subject) 

    Sets the subject.

 public  void setTemplate(String template) 

    Sets the template.

 public  void setThumbnail(byte[] thumbnail) 

    Sets the thumbnail.

 public  void setTitle(String title) 

    Sets the title.

 public  void setWordCount(int wordCount) 

    Sets the word count.