jakarta-poi 1.5.1-final API: Class SpecialPropertySet

Overview

Package

Class

Use

Tree

Deprecated

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.hpsf
Class SpecialPropertySet

java.lang.Object
  |
  +--org.apache.poi.hpsf.PropertySet
        |
        +--org.apache.poi.hpsf.SpecialPropertySet

Direct Known Subclasses:: DocumentSummaryInformation, SummaryInformation

public abstract class SpecialPropertySet
extends PropertySet

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.

Since:: 2002-02-09
Version:: $Id: SpecialPropertySet.java,v 1.1 2002/02/14 04:00:59 mjohnson Exp $
Author:: Rainer Klute (klute@rainer-klute.de)

Constructor Summary

SpecialPropertySet(PropertySet ps)


Method Summary

Word getByteOrder()
          Returns the property set stream's low-level "byte order" field.

ClassID getClassID()
          Returns the property set stream's low-level "class ID" field.

Word getFormat()
          Returns the property set stream's low-level "format" field.

DWord getOSVersion()
          Returns the property set stream's low-level "OS version" field.

int getSectionCount()
          Returns the number of Sections in the property set.

java.util.List getSections()
          Returns the Sections in the property set.

Section getSingleSection()
          If the PropertySet has only a single section this method returns it.

boolean isDocumentSummaryInformation()
          Checks whether this PropertySet is a Document Summary Information.

boolean isSummaryInformation()
          Checks whether this PropertySet represents a Summary Information.

Methods inherited from class org.apache.poi.hpsf.PropertySet

getProperties, getProperty, getPropertyIntValue, isPropertySetStream, isPropertySetStream, wasNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpecialPropertySet

public SpecialPropertySet(PropertySet ps)

Method Detail