All Packages from org.apache.poi.hpsf.basic.* to org.apache.poi.hpsf.wellknown.*

Home >> All >> org >> apache >> poi >> [ hpsf Javadoc ]

•

• org.apache.poi.hpsf: Javadoc index of package org.apache.poi.hpsf.

Package Samples:

• org.apache.poi.hpsf.wellknown: Horrible PropertySet Format API reads things like Document Summary info from OLE 2 Compound document files.
• org.apache.poi.hpsf.examples
• org.apache.poi.hpsf.basic

Classes:

• PropertySet: Represents a property set in the Horrible Property Set Format (HPSF). These are usually metadata of a Microsoft Office document. An application that wants to access these metadata should create an instance of this class or one of its subclasses by calling the factory method PropertySetFactory.create(java.io.InputStream) 55 and then retrieve the information its needs by calling appropriate methods. PropertySetFactory.create(java.io.InputStream) 55 does its work by calling one of the constructors PropertySet(InputStream) 55 or PropertySet(byte[]) 55 . If the constructor's argument is not in the Horrible ...
• 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 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 ...
• Property: A property in a Section of a PropertySet . The property's ID gives the property a meaning in the context of its Section . Each Section spans its own name space of property IDs. The property's type determines how its value is interpreted. For example, if the type is Variant.VT_LPSTR 55 (byte string), the value consists of a DWord telling how many bytes the string contains. The bytes follow immediately, including any null bytes that terminate the string. The type Variant.VT_I4 55 denotes a four-byte integer value, Variant.VT_FILETIME 55 some date and time (of a file). FIXME: Reading is not implemented ...
• SectionIDMap: Maps section format IDs to PropertyIDMap s. It is initialized with two well-known section format IDs: those of the \005SummaryInformation stream and the \005DocumentSummaryInformation stream. If you have a section format ID you can use it as a key to query this map. If you get a PropertyIDMap returned your section is well-known and you can query the PropertyIDMap for PID strings. If you get back null you are on your own. This java.util.Map expects the byte arrays of section format IDs as keys. A key maps to a PropertyIDMap describing the property IDs in sections with the specified section format ...
• PropertyIDMap: This is a dictionary which maps property ID values to property ID strings. The methods getSummaryInformationProperties() 55 and getDocumentSummaryInformationProperties() 55 return singleton PropertyIDMap s. An application that wants to extend these maps should treat them as unmodifiable, copy them and modifiy the copies. FIXME: Make the singletons unmodifiable. However, since this requires to use a java.util.HashMap delegate instead of extending java.util.HashMap and thus requires a lot of stupid typing. I won't do that for the time being.
• 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 . The constructors of this class are analogous to those of its superclass and documented there.
• Variant: The Variant types as defined by Microsoft's COM. I found this information in http://www.marin.clara.net/COM/variant_type_definitions.htm . In the variant types descriptions the following shortcuts are used: [V] - may appear in a VARIANT, [T] - may appear in a TYPEDESC, [P] - may appear in an OLE property set, [S] - may appear in a Safe Array.
• IllegalPropertySetDataException: This exception is thrown when there is an illegal value set in a PropertySet . For example, a Variant.VT_BOOL 55 must have a value of -1 (true) or 0 (false) . Any other value would trigger this exception. It supports a nested "reason" throwable, i.e. an exception that caused this one to be thrown.
• PropertySetFactory: Factory class to create instances of SummaryInformation , DocumentSummaryInformation and PropertySet .
• SummaryInformation: Convenience class representing a Summary Information stream in a Microsoft Office document. See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/com/stgu_8910.asp for documentation from That Redmond Company.
• ClassID: Represents a class ID (16 bytes). Unlike other little-endian type the ClassID is not just 16 bytes stored in the wrong order. Instead, it is a double word (4 bytes) followed by two words (2 bytes each) followed by 8 bytes.
• 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. The constructors of this class are analogous to those of its superclass and documented there.
• 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. The constructors of this class are analogous to those of its superclass and documented there.
• MarkUnsupportedException: This exception is thrown if an java.io.InputStream does not support the InputStream.mark(int) > InputStream.mark(int) 55 operation.
• ReadCustomPropertySets: Sample application showing how to read a custom property set of a document. Call it with the document's file name as command line parameter. Explanations can be found in the HPSF HOW-TO.
• HPSFRuntimeException: This exception is the superclass of all other unchecked exceptions thrown in this package. It supports a nested "reason" throwable, i.e. an exception that caused this one to be thrown.
• ReadTitle: Sample application showing how to read a OLE 2 document's title. Call it with the document's file name as command line parameter. Explanations can be found in the HPSF HOW-TO.
• HPSFException: This exception is the superclass of all other checked exceptions thrown in this package. It supports a nested "reason" throwable, i.e. an exception that caused this one to be thrown.
• Section: Represents a section in a PropertySet .
• Thumbnail: Class to manipulate data in the Clipboard Variant ( VT_CF 55 ) format.
• TestEmptyProperties: Test case for OLE2 files with empty properties. An empty property's type is Variant.VT_EMPTY .
• DocumentSummaryInformation: Convenience class representing a DocumentSummary Information stream in a Microsoft Office document.
• TestUnicode: Tests whether Unicode string can be read from a DocumentSummaryInformation.
• Util: Static utility methods needed by the HPSF test cases.
• Util: Provides various static utility methods.

Home | Contact Us | Privacy Policy | Terms of Service