Java Doc for SpecialPropertySet.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

All known Subclasses:   org.apache.poi.hpsf.SummaryInformation,  org.apache.poi.hpsf.DocumentSummaryInformation,
SpecialPropertySet
abstract public class SpecialPropertySet extends MutablePropertySet (Code)

Abstract superclass for the convenience classes SummaryInformation and DocumentSummaryInformation .

The motivation behind this class is quite nasty if you look behind the scenes, but it serves the application programmer well by providing him with the easy-to-use SummaryInformation and DocumentSummaryInformation classes. When parsing the data a property set stream consists of (possibly coming from an java.io.InputStream ) we want to read and process each byte only once. Since we don't know in advance which kind of property set we have, we can expect only the most general PropertySet . Creating a special subclass should be as easy as calling the special subclass' constructor and pass the general PropertySet in. To make things easy internally, the special class just holds a reference to the general PropertySet and delegates all method calls to it.

A cleaner implementation would have been like this: The PropertySetFactory parses the stream data into some internal object first. Then it finds out whether the stream is a SummaryInformation , a DocumentSummaryInformation or a general PropertySet . However, the current implementation went the other way round historically: the convenience classes came only late to my mind.


author:
   Rainer Klute author:
   href="mailto:klute@rainer-klute.de"><klute@rainer-klute.de>
version:
   $Id: SpecialPropertySet.java 489730 2006-12-22 19:18:16Z bayard $
since:
   2002-02-09



Constructor Summary
public  SpecialPropertySet(PropertySet ps)
    

Creates a SpecialPropertySet.

public  SpecialPropertySet(MutablePropertySet ps)
    

Creates a SpecialPropertySet.


Method Summary
public  voidaddSection(Section section)
    
public  voidclearSections()
    
public  booleanequals(Object o)
    
public  intgetByteOrder()
    
public  ClassIDgetClassID()
    
public  SectiongetFirstSection()
    
public  intgetFormat()
    
public  intgetOSVersion()
    
public  Property[]getProperties()
    
protected  ObjectgetProperty(int id)
    
protected  booleangetPropertyBooleanValue(int id)
    
protected  intgetPropertyIntValue(int id)
    
public  intgetSectionCount()
    
public  ListgetSections()
    
public  inthashCode()
    
public  booleanisDocumentSummaryInformation()
    
public  booleanisSummaryInformation()
    
public  voidsetByteOrder(int byteOrder)
    
public  voidsetClassID(ClassID classID)
    
public  voidsetFormat(int format)
    
public  voidsetOSVersion(int osVersion)
    
public  InputStreamtoInputStream()
    
public  StringtoString()
    
public  booleanwasNull()
    
public  voidwrite(DirectoryEntry dir, String name)
    
public  voidwrite(OutputStream out)
    


Constructor Detail
SpecialPropertySet
public SpecialPropertySet(PropertySet ps)(Code)

Creates a SpecialPropertySet.
Parameters:
  ps - The property set to be encapsulated by theSpecialPropertySet




SpecialPropertySet
public SpecialPropertySet(MutablePropertySet ps)(Code)

Creates a SpecialPropertySet.
Parameters:
  ps - The mutable property set to be encapsulated by theSpecialPropertySet





Method Detail
addSection
public void addSection(Section section)(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.addSection(org.apache.poi.hpsf.Section)



clearSections
public void clearSections()(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.clearSections



equals
public boolean equals(Object o)(Code)

See Also:   org.apache.poi.hpsf.PropertySet.equals(java.lang.Object)



getByteOrder
public int getByteOrder()(Code)

See Also:   PropertySet.getByteOrder



getClassID
public ClassID getClassID()(Code)

See Also:   PropertySet.getClassID



getFirstSection
public Section getFirstSection()(Code)

See Also:   PropertySet.getSingleSection



getFormat
public int getFormat()(Code)

See Also:   PropertySet.getFormat



getOSVersion
public int getOSVersion()(Code)

See Also:   PropertySet.getOSVersion



getProperties
public Property[] getProperties() throws NoSingleSectionException(Code)

See Also:   org.apache.poi.hpsf.PropertySet.getProperties



getProperty
protected Object getProperty(int id) throws NoSingleSectionException(Code)

See Also:   org.apache.poi.hpsf.PropertySet.getProperty(int)



getPropertyBooleanValue
protected boolean getPropertyBooleanValue(int id) throws NoSingleSectionException(Code)

See Also:   org.apache.poi.hpsf.PropertySet.getPropertyBooleanValue(int)



getPropertyIntValue
protected int getPropertyIntValue(int id) throws NoSingleSectionException(Code)

See Also:   org.apache.poi.hpsf.PropertySet.getPropertyIntValue(int)



getSectionCount
public int getSectionCount()(Code)

See Also:   PropertySet.getSectionCount



getSections
public List getSections()(Code)

See Also:   PropertySet.getSections



hashCode
public int hashCode()(Code)

See Also:   org.apache.poi.hpsf.PropertySet.hashCode



isDocumentSummaryInformation
public boolean isDocumentSummaryInformation()(Code)

See Also:   PropertySet.isDocumentSummaryInformation



isSummaryInformation
public boolean isSummaryInformation()(Code)

See Also:   PropertySet.isSummaryInformation



setByteOrder
public void setByteOrder(int byteOrder)(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.setByteOrder(int)



setClassID
public void setClassID(ClassID classID)(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.setClassID(org.apache.poi.hpsf.ClassID)



setFormat
public void setFormat(int format)(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.setFormat(int)



setOSVersion
public void setOSVersion(int osVersion)(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.setOSVersion(int)



toInputStream
public InputStream toInputStream() throws IOException, WritingNotSupportedException(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.toInputStream



toString
public String toString()(Code)

See Also:   org.apache.poi.hpsf.PropertySet.toString



wasNull
public boolean wasNull() throws NoSingleSectionException(Code)

See Also:   org.apache.poi.hpsf.PropertySet.wasNull



write
public void write(DirectoryEntry dir, String name) throws WritingNotSupportedException, IOException(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.write(org.apache.poi.poifs.filesystem.DirectoryEntryjava.lang.String)



write
public void write(OutputStream out) throws WritingNotSupportedException, IOException(Code)

See Also:   org.apache.poi.hpsf.MutablePropertySet.write(java.io.OutputStream)



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.