|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hpsf.PropertySet | +--org.apache.poi.hpsf.SpecialPropertySet
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 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.
Constructor Summary | |
SpecialPropertySet(PropertySet ps)
Constructor for the SpecialPropertySet object |
Method Summary | |
int |
getByteOrder()
Gets the byteOrder attribute of the SpecialPropertySet object |
ClassID |
getClassID()
Gets the classID attribute of the SpecialPropertySet object |
int |
getFormat()
Gets the format attribute of the SpecialPropertySet object |
long |
getOSVersion()
Gets the oSVersion attribute of the SpecialPropertySet object |
long |
getSectionCount()
Gets the sectionCount attribute of the SpecialPropertySet object |
java.util.List |
getSections()
Gets the sections attribute of the SpecialPropertySet object |
Section |
getSingleSection()
Gets the singleSection attribute of the SpecialPropertySet object |
boolean |
isDocumentSummaryInformation()
Gets the documentSummaryInformation attribute of the SpecialPropertySet object |
boolean |
isSummaryInformation()
Gets the summaryInformation attribute of the SpecialPropertySet object |
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 SpecialPropertySet(PropertySet ps)
ps
- Description of the ParameterMethod Detail |
public int getByteOrder()
getByteOrder
in class PropertySet
public int getFormat()
getFormat
in class PropertySet
public long getOSVersion()
getOSVersion
in class PropertySet
public ClassID getClassID()
getClassID
in class PropertySet
public long getSectionCount()
getSectionCount
in class PropertySet
public java.util.List getSections()
getSections
in class PropertySet
public boolean isSummaryInformation()
isSummaryInformation
in class PropertySet
public boolean isDocumentSummaryInformation()
isDocumentSummaryInformation
in class PropertySet
public Section getSingleSection()
getSingleSection
in class PropertySet
|
jakarta-poi 1.7.0-dev | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |