|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.poi.hpsf.wellknown.SectionIDMap
@Internal public class 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 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.
Field Summary | |
---|---|
static ClassID[] |
DOCUMENT_SUMMARY_INFORMATION_ID
|
static ClassID |
SUMMARY_INFORMATION_ID
The SummaryInformation's section's format ID. |
static java.lang.String |
UNDEFINED
A property without a known name is described by this string. |
Constructor Summary | |
---|---|
SectionIDMap()
|
Method Summary | |
---|---|
PropertyIDMap |
get(ClassID sectionFormatID)
Returns the PropertyIDMap for a given section format
ID. |
static SectionIDMap |
getInstance()
Returns the singleton instance of the default SectionIDMap . |
static java.lang.String |
getPIDString(ClassID sectionFormatID,
long pid)
Returns the property ID string that is associated with a given property ID in a section format ID's namespace. |
PropertyIDMap |
put(ClassID sectionFormatID,
PropertyIDMap propertyIDMap)
Associates a section format ID with a PropertyIDMap . |
protected PropertyIDMap |
put(java.lang.String key,
PropertyIDMap value)
Associates the string representation of a section format ID with a PropertyIDMap |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final ClassID SUMMARY_INFORMATION_ID
The SummaryInformation's section's format ID.
public static final ClassID[] DOCUMENT_SUMMARY_INFORMATION_ID
public static final java.lang.String UNDEFINED
Constructor Detail |
---|
public SectionIDMap()
Method Detail |
---|
public static SectionIDMap getInstance()
Returns the singleton instance of the default SectionIDMap
.
public static java.lang.String getPIDString(ClassID sectionFormatID, long pid)
Returns the property ID string that is associated with a given property ID in a section format ID's namespace.
sectionFormatID
- Each section format ID has its own name
space of property ID strings and thus must be specified.pid
- The property ID
public PropertyIDMap get(ClassID sectionFormatID)
Returns the PropertyIDMap
for a given section format
ID.
sectionFormatID
- the section format ID
public PropertyIDMap put(ClassID sectionFormatID, PropertyIDMap propertyIDMap)
PropertyIDMap
.
sectionFormatID
- the section format IDpropertyIDMap
- the property ID map
Map.put(K, V)
protected PropertyIDMap put(java.lang.String key, PropertyIDMap value)
PropertyIDMap
key
- the key of the PropertyIDMapvalue
- the PropertyIDMap itself
null
if there wasn't one
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |