| java.util.HashMap
 org.apache.poi.hpsf.wellknown.SectionIDMap
| SectionIDMap | | public class SectionIDMap extends HashMap (Code) | | 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 ID.
author:
Rainer Klute (klute@rainer-klute.de)
version:
$Id: SectionIDMap.java 489730 2006-12-22 19:18:16Z bayard $
since:
2002-02-09 |
| Method Summary | |
| public PropertyIDMap | get(byte[] sectionFormatID)
| | public Object | get(Object sectionFormatID)
| | public static SectionIDMap | getInstance()
| | public static String | getPIDString(byte[] sectionFormatID, long pid)
Returns the property ID string that is associated with a
given property ID in a section format ID's namespace.
Parameters:
sectionFormatID - Each section format ID has its own namespace of property ID strings and thus must be specified.
Parameters:
pid - The property ID The well-known property ID string associated with theproperty ID pid in the name space spanned by sectionFormatID . | | public Object | put(byte[] sectionFormatID, PropertyIDMap propertyIDMap)
| | public Object | put(Object key, Object value)
SectionIDMap.put(byte[],PropertyIDMap)
See Also: SectionIDMap.put(byte[],PropertyIDMap)
Parameters:
key - This parameter remains undocumented since the method isdeprecated.
Parameters:
value - This parameter remains undocumented since the method isdeprecated. |
| DOCUMENT_SUMMARY_INFORMATION_ID | | final public static byte[][] DOCUMENT_SUMMARY_INFORMATION_ID(Code) | | The DocumentSummaryInformation's first and second sections' format
ID.
|
| SUMMARY_INFORMATION_ID | | final public static byte[] SUMMARY_INFORMATION_ID(Code) | | The SummaryInformation's section's format ID.
|
| UNDEFINED | | final public static String UNDEFINED(Code) | | A property without a known name is described by this string.
|
| get | | public PropertyIDMap get(byte[] sectionFormatID)(Code) | | Returns the
PropertyIDMap for a given section format
ID.
Parameters:
sectionFormatID - the section format ID the property ID map |
| getPIDString | | public static String getPIDString(byte[] sectionFormatID, long pid)(Code) | | Returns the property ID string that is associated with a
given property ID in a section format ID's namespace.
Parameters:
sectionFormatID - Each section format ID has its own namespace of property ID strings and thus must be specified.
Parameters:
pid - The property ID The well-known property ID string associated with theproperty ID pid in the name space spanned by sectionFormatID . If the pid/sectionFormatID combination is not well-known, thestring "[undefined]" is returned. |
|
|