Java Doc for DocumentSummaryInformation.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hpsf » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Collaboration » poi 3.0.2 beta2 » org.apache.poi.hpsf 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.poi.hpsf.PropertySet
      org.apache.poi.hpsf.MutablePropertySet
         org.apache.poi.hpsf.SpecialPropertySet
            org.apache.poi.hpsf.DocumentSummaryInformation

DocumentSummaryInformation
public class DocumentSummaryInformation extends SpecialPropertySet (Code)

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


author:
   Rainer Klute author:
   href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de>
author:
   Drew Varner (Drew.Varner closeTo sc.edu)
author:
   robert_flaherty@hyperion.com
See Also:   SummaryInformation
version:
   $Id: DocumentSummaryInformation.java 489730 2006-12-22 19:18:16Z bayard $
since:
   2002-02-09


Field Summary
final public static  StringDEFAULT_STREAM_NAME
    

Constructor Summary
public  DocumentSummaryInformation(PropertySet ps)
    

Method Summary
public  intgetByteCount()
    
public  StringgetCategory()
    
public  StringgetCompany()
    
public  CustomPropertiesgetCustomProperties()
    
public  byte[]getDocparts()
    

Returns the doc parts (or null) when this method is implemented.

public  byte[]getHeadingPair()
    

Returns the heading pair (or null) when this method is implemented.

public  intgetHiddenCount()
    
public  intgetLineCount()
    
public  booleangetLinksDirty()
    
public  intgetMMClipCount()
    
public  StringgetManager()
    
public  intgetNoteCount()
    
public  intgetParCount()
    
public  StringgetPresentationFormat()
    
public  booleangetScale()
    
public  intgetSlideCount()
    
public  voidremoveByteCount()
    
public  voidremoveCategory()
    
public  voidremoveCompany()
    
public  voidremoveCustomProperties()
    
public  voidremoveDocparts()
    
public  voidremoveHeadingPair()
    
public  voidremoveHiddenCount()
    
public  voidremoveLineCount()
    
public  voidremoveLinksDirty()
    
public  voidremoveMMClipCount()
    
public  voidremoveManager()
    
public  voidremoveNoteCount()
    
public  voidremoveParCount()
    
public  voidremovePresentationFormat()
    
public  voidremoveScale()
    
public  voidremoveSlideCount()
    
public  voidsetByteCount(int byteCount)
    
public  voidsetCategory(String category)
    
public  voidsetCompany(String company)
    
public  voidsetCustomProperties(CustomProperties customProperties)
    
public  voidsetDocparts(byte[] docparts)
    
public  voidsetHeadingPair(byte[] headingPair)
    
public  voidsetHiddenCount(int hiddenCount)
    
public  voidsetLineCount(int lineCount)
    
public  voidsetLinksDirty(boolean linksDirty)
    
public  voidsetMMClipCount(int mmClipCount)
    
public  voidsetManager(String manager)
    
public  voidsetNoteCount(int noteCount)
    
public  voidsetParCount(int parCount)
    
public  voidsetPresentationFormat(String presentationFormat)
    
public  voidsetScale(boolean scale)
    
public  voidsetSlideCount(int slideCount)
    

Field Detail
DEFAULT_STREAM_NAME
final public static String DEFAULT_STREAM_NAME(Code)

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





Constructor Detail
DocumentSummaryInformation
public DocumentSummaryInformation(PropertySet ps) throws UnexpectedPropertySetTypeException(Code)

Creates a DocumentSummaryInformation from a given PropertySet .


Parameters:
  ps - A property set which should be created from adocument summary information stream.
throws:
  UnexpectedPropertySetTypeException - if psdoes not contain a document summary information stream.




Method Detail
getByteCount
public int getByteCount()(Code)

Returns the byte count or 0 if the DocumentSummaryInformation does not contain a byte count.

The byteCount value



getCategory
public String getCategory()(Code)

Returns the category (or null).

The category value



getCompany
public String getCompany()(Code)

Returns the company (or null).

The company value



getCustomProperties
public CustomProperties getCustomProperties()(Code)

Gets the custom properties.

The custom properties.
since:
   2006-02-09



getDocparts
public byte[] getDocparts()(Code)

Returns the doc parts (or null) when this method is implemented. Please note that the return type is likely to change! The doc parts value




getHeadingPair
public byte[] getHeadingPair()(Code)

Returns the heading pair (or null) when this method is implemented. Please note that the return type is likely to change! The heading pair value




getHiddenCount
public int getHiddenCount()(Code)

Returns the hidden count or 0 if the DocumentSummaryInformation does not contain a hidden count.

The hidden count value



getLineCount
public int getLineCount()(Code)

Returns the line count or 0 if the DocumentSummaryInformation does not contain a line count.

The line count value



getLinksDirty
public boolean getLinksDirty()(Code)

Returns true if the custom links are dirty.

The links dirty value




getMMClipCount
public int getMMClipCount()(Code)

Returns the mmclip count or 0 if the DocumentSummaryInformation does not contain a mmclip count.

The mmclip count value



getManager
public String getManager()(Code)

Returns the manager (or null).

The manager value



getNoteCount
public int getNoteCount()(Code)

Returns the note count or 0 if the DocumentSummaryInformation does not contain a note count.

The note count value



getParCount
public int getParCount()(Code)

Returns the par count or 0 if the DocumentSummaryInformation does not contain a par count.

The par count value



getPresentationFormat
public String getPresentationFormat()(Code)

Returns the presentation format (or null).

The presentation format value



getScale
public boolean getScale()(Code)

Returns true when scaling of the thumbnail is desired, false if cropping is desired.

The scale value



getSlideCount
public int getSlideCount()(Code)

Returns the slide count or 0 if the DocumentSummaryInformation does not contain a slide count.

The slide count value



removeByteCount
public void removeByteCount()(Code)

Removes the byte count.




removeCategory
public void removeCategory()(Code)

Removes the category.




removeCompany
public void removeCompany()(Code)

Removes the company.




removeCustomProperties
public void removeCustomProperties()(Code)

Removes the custom properties.


since:
   2006-02-08



removeDocparts
public void removeDocparts()(Code)

Removes the doc parts.




removeHeadingPair
public void removeHeadingPair()(Code)

Removes the heading pair.




removeHiddenCount
public void removeHiddenCount()(Code)

Removes the hidden count.




removeLineCount
public void removeLineCount()(Code)

Removes the line count.




removeLinksDirty
public void removeLinksDirty()(Code)

Removes the links dirty.




removeMMClipCount
public void removeMMClipCount()(Code)

Removes the mmclip count.




removeManager
public void removeManager()(Code)

Removes the manager.




removeNoteCount
public void removeNoteCount()(Code)

Removes the noteCount.




removeParCount
public void removeParCount()(Code)

Removes the par count.




removePresentationFormat
public void removePresentationFormat()(Code)

Removes the presentation format.




removeScale
public void removeScale()(Code)

Removes the scale.




removeSlideCount
public void removeSlideCount()(Code)

Removes the slide count.




setByteCount
public void setByteCount(int byteCount)(Code)

Sets the byte count.


Parameters:
  byteCount - The byte count to set.



setCategory
public void setCategory(String category)(Code)

Sets the category.


Parameters:
  category - The category to set.



setCompany
public void setCompany(String company)(Code)

Sets the company.


Parameters:
  company - The company to set.



setCustomProperties
public void setCustomProperties(CustomProperties customProperties)(Code)

Sets the custom properties.


Parameters:
  customProperties - The custom properties
since:
   2006-02-07



setDocparts
public void setDocparts(byte[] docparts)(Code)

Sets the doc parts.


Parameters:
  docparts - The doc parts to set.



setHeadingPair
public void setHeadingPair(byte[] headingPair)(Code)

Sets the heading pair.


Parameters:
  headingPair - The heading pair to set.



setHiddenCount
public void setHiddenCount(int hiddenCount)(Code)

Sets the hidden count.


Parameters:
  hiddenCount - The hidden count to set.



setLineCount
public void setLineCount(int lineCount)(Code)

Sets the line count.


Parameters:
  lineCount - The line count to set.



setLinksDirty
public void setLinksDirty(boolean linksDirty)(Code)

Sets the linksDirty.


Parameters:
  linksDirty - The links dirty value to set.



setMMClipCount
public void setMMClipCount(int mmClipCount)(Code)

Sets the mmclip count.


Parameters:
  mmClipCount - The mmclip count to set.



setManager
public void setManager(String manager)(Code)

Sets the manager.


Parameters:
  manager - The manager to set.



setNoteCount
public void setNoteCount(int noteCount)(Code)

Sets the note count.


Parameters:
  noteCount - The note count to set.



setParCount
public void setParCount(int parCount)(Code)

Sets the par count.


Parameters:
  parCount - The par count to set.



setPresentationFormat
public void setPresentationFormat(String presentationFormat)(Code)

Sets the presentation format.


Parameters:
  presentationFormat - The presentation format to set.



setScale
public void setScale(boolean scale)(Code)

Sets the scale.


Parameters:
  scale - The scale to set.



setSlideCount
public void setSlideCount(int slideCount)(Code)

Sets the slideCount.


Parameters:
  slideCount - The slide count to set.



Methods inherited from org.apache.poi.hpsf.SpecialPropertySet
public void addSection(Section section)(Code)(Java Doc)
public void clearSections()(Code)(Java Doc)
public boolean equals(Object o)(Code)(Java Doc)
public int getByteOrder()(Code)(Java Doc)
public ClassID getClassID()(Code)(Java Doc)
public Section getFirstSection()(Code)(Java Doc)
public int getFormat()(Code)(Java Doc)
public int getOSVersion()(Code)(Java Doc)
public Property[] getProperties() throws NoSingleSectionException(Code)(Java Doc)
protected Object getProperty(int id) throws NoSingleSectionException(Code)(Java Doc)
protected boolean getPropertyBooleanValue(int id) throws NoSingleSectionException(Code)(Java Doc)
protected int getPropertyIntValue(int id) throws NoSingleSectionException(Code)(Java Doc)
public int getSectionCount()(Code)(Java Doc)
public List getSections()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isDocumentSummaryInformation()(Code)(Java Doc)
public boolean isSummaryInformation()(Code)(Java Doc)
public void setByteOrder(int byteOrder)(Code)(Java Doc)
public void setClassID(ClassID classID)(Code)(Java Doc)
public void setFormat(int format)(Code)(Java Doc)
public void setOSVersion(int osVersion)(Code)(Java Doc)
public InputStream toInputStream() throws IOException, WritingNotSupportedException(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public boolean wasNull() throws NoSingleSectionException(Code)(Java Doc)
public void write(DirectoryEntry dir, String name) throws WritingNotSupportedException, IOException(Code)(Java Doc)
public void write(OutputStream out) throws WritingNotSupportedException, IOException(Code)(Java Doc)

Methods inherited from org.apache.poi.hpsf.MutablePropertySet
public void addSection(Section section)(Code)(Java Doc)
public void clearSections()(Code)(Java Doc)
public void setByteOrder(int byteOrder)(Code)(Java Doc)
public void setClassID(ClassID classID)(Code)(Java Doc)
public void setFormat(int format)(Code)(Java Doc)
public void setOSVersion(int osVersion)(Code)(Java Doc)
public InputStream toInputStream() throws IOException, WritingNotSupportedException(Code)(Java Doc)
public void write(OutputStream out) throws WritingNotSupportedException, IOException(Code)(Java Doc)
public void write(DirectoryEntry dir, String name) throws WritingNotSupportedException, IOException(Code)(Java Doc)

Fields inherited from org.apache.poi.hpsf.PropertySet
final static byte[] BYTE_ORDER_ASSERTION(Code)(Java Doc)
final static byte[] FORMAT_ASSERTION(Code)(Java Doc)
final public static int OS_MACINTOSH(Code)(Java Doc)
final public static int OS_WIN16(Code)(Java Doc)
final public static int OS_WIN32(Code)(Java Doc)
protected int byteOrder(Code)(Java Doc)
protected ClassID classID(Code)(Java Doc)
protected int format(Code)(Java Doc)
protected int osVersion(Code)(Java Doc)
protected List sections(Code)(Java Doc)

Methods inherited from org.apache.poi.hpsf.PropertySet
public boolean equals(Object o)(Code)(Java Doc)
public int getByteOrder()(Code)(Java Doc)
public ClassID getClassID()(Code)(Java Doc)
public Section getFirstSection()(Code)(Java Doc)
public int getFormat()(Code)(Java Doc)
public int getOSVersion()(Code)(Java Doc)
public Property[] getProperties() throws NoSingleSectionException(Code)(Java Doc)
protected Object getProperty(int id) throws NoSingleSectionException(Code)(Java Doc)
protected boolean getPropertyBooleanValue(int id) throws NoSingleSectionException(Code)(Java Doc)
protected int getPropertyIntValue(int id) throws NoSingleSectionException(Code)(Java Doc)
public int getSectionCount()(Code)(Java Doc)
public List getSections()(Code)(Java Doc)
public Section getSingleSection()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
public boolean isDocumentSummaryInformation()(Code)(Java Doc)
public static boolean isPropertySetStream(InputStream stream) throws MarkUnsupportedException, IOException(Code)(Java Doc)
public static boolean isPropertySetStream(byte[] src, int offset, int length)(Code)(Java Doc)
public boolean isSummaryInformation()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public boolean wasNull() throws NoSingleSectionException(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.