Apache POI - Common 5.3.0 · org.apache.poi.hpsf · APIdia, the JavaDoc alternative

Processes streams in the Horrible Property Set Format (HPSF) in POI filesystems. Microsoft Office documents, i.e. POI filesystems, usually contain meta data like author, title, last saving time etc. These items are called properties and stored in property set streams along with the document itself. These streams are commonly named \005SummaryInformation and \005DocumentSummaryInformation. However, a POI filesystem may contain further property sets of other names or types.

In order to extract the properties from a POI filesystem, a property set stream's contents must be parsed into a org.apache.poi.hpsf.PropertySet instance. Its subclasses org.apache.poi.hpsf.SummaryInformation and org.apache.poi.hpsf.DocumentSummaryInformation deal with the well-known property set streams \005SummaryInformation and \005DocumentSummaryInformation. (However, the streams' names are irrelevant. What counts is the property set's first section's format ID - see below.)

The factory method org.apache.poi.hpsf.PropertySetFactory#create creates a PropertySet instance. This method always returns the most specific property set: If it identifies the stream data as a Summary Information or as a Document Summary Information it returns an instance of the corresponding class, else the general PropertySet.

A PropertySet contains a list of Sections which can be retrieved with org.apache.poi.hpsf.PropertySet#getSections. Each Section contains a org.apache.poi.hpsf.Property array which can be retrieved with org.apache.poi.hpsf.Section#getProperties. Since the vast majority of PropertySets contains only a single Section, the convenience method org.apache.poi.hpsf.PropertySet#getProperties returns the properties of a PropertySets Section (throwing a org.apache.poi.hpsf.NoSingleSectionException if the PropertySet contains more (or less) than exactly one Section).

Each Property has an ID, a type, and a value which can be retrieved with org.apache.poi.hpsf.Property#getID, org.apache.poi.hpsf.Property#getType, and org.apache.poi.hpsf.Property#getValue, respectively. The value's class depends on the property's type. The current implementation does not yet support all property types and restricts the values' classes to String, Integer and Date. A value of a yet unknown type is returned as a byte array containing the values origin bytes from the property set stream.

To retrieve the value of a specific Property, use org.apache.poi.hpsf.Section#getProperty or org.apache.poi.hpsf.Section#getPropertyIntValue.

The SummaryInformation and DocumentSummaryInformation classes provide convenience methods for retrieving well-known properties. For example, an application that wants to retrieve a document's title string just calls org.apache.poi.hpsf.SummaryInformation#getTitle instead of going through the hassle of first finding out what the title's property ID is and then using this ID to get the property's value.

Class Summary

Modifier and Type	Class and Description
public class	Array
public class	Blob
public class	ClassID Represents a class ID (16 bytes).
public class	ClipboardData
public class	CodePageString
public class	Currency
public class	CustomProperties Maintains the instances of `CustomProperty` that belong to a `DocumentSummaryInformation`.
public class	CustomProperty This class represents custom properties in the document summary information stream.
public class	Date
public class	Decimal
public class	DocumentSummaryInformation Convenience class representing a DocumentSummary Information stream in a Microsoft Office document.
public class	Filetime The Windows FILETIME structure holds a date and time associated with a file.
public class	GUID
public class	HPSFException This exception is the superclass of all other checked exceptions thrown in this package.
public class	HPSFPropertiesOnlyDocument A version of `POIDocument` which allows access to the HPSF Properties, but no other document contents.
public class	HPSFRuntimeException This exception is the superclass of all other unchecked exceptions thrown in this package.
public class	IllegalPropertySetDataException This exception is thrown when there is an illegal value set in a `PropertySet`.
public class	IllegalVariantTypeException This exception is thrown if HPSF encounters a variant type that is illegal in the current context.
public class	IndirectPropertyName
public class	MissingSectionException This exception is thrown if one of the `PropertySet`'s convenience methods does not find a required `Section`.
public class	NoFormatIDException This exception is thrown if a `PropertySet` is to be written but does not have a formatID set (see `Section#setFormatID(ClassID)` or `org.apache.poi.hpsf.Section#setFormatID(byte[])`.
public class	NoPropertySetStreamException This exception is thrown if a format error in a property set stream is detected or when the input data do not constitute a property set stream.
public class	NoSingleSectionException This exception is thrown if one of the `PropertySet`'s convenience methods that require a single `Section` is called and the `PropertySet` does not contain exactly one `Section`.
public class	Property A property in a `Section` of a `PropertySet`.
public class	PropertySet Represents a property set in the Horrible Property Set Format (HPSF).
public class	PropertySetFactory Factory class to create instances of `SummaryInformation`, `DocumentSummaryInformation` and `PropertySet`.
public class	ReadingNotSupportedException This exception is thrown when HPSF tries to read a (yet) unsupported variant type.
public class	Section Represents a section in a `PropertySet`.
public class	SummaryInformation Convenience class representing a Summary Information stream in a Microsoft Office document.
public class	Thumbnail Class to manipulate data in the Clipboard Variant (`VT_CF`) format.
public class	TypedPropertyValue
public class	UnexpectedPropertySetTypeException This exception is thrown if a certain type of property set is expected (e.g. a Document Summary Information) but the provided property set is not of that type.
public class	UnicodeString
public abstract class	UnsupportedVariantTypeException This exception is thrown if HPSF encounters a variant type that isn't supported yet.
public class	Variant The `Variant` types as defined by Microsoft's COM.
public class	VariantBool
public class	VariantSupport Supports reading and writing of variant data.
public abstract class	VariantTypeException This exception is thrown if HPSF encounters a problem with a variant type.
public class	Vector Holder for vector-type properties
public class	VersionedStream
public class	WritingNotSupportedException This exception is thrown when trying to write a (yet) unsupported variant type.

Package org.apache.poi.hpsf

Class Summary

Enum Summary