SectionIDMap (POI API Documentation)

java.lang.Object
- java.util.AbstractMap<K,V>
- - java.util.HashMap
  - - org.apache.poi.hpsf.wellknown.SectionIDMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map
```
public class SectionIDMap
extends java.util.HashMap
```
Maps section format IDs to PropertyIDMaps. 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.

See Also:
Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields
Modifier and Type	Field and Description
`static byte[][]`	`DOCUMENT_SUMMARY_INFORMATION_ID` The DocumentSummaryInformation's first and second sections' format ID.
`static byte[]`	`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

Constructors
Constructor and Description

SectionIDMap()

Constructors
Constructor and Description
`SectionIDMap()`

Method Summary

Methods
Modifier and Type	Method and Description
`PropertyIDMap`	`get(byte[] 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(byte[] 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(byte[] 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.util.HashMap
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap
equals, hashCode, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
equals, hashCode

- Field Detail
  - SUMMARY_INFORMATION_ID
```
public static final byte[] SUMMARY_INFORMATION_ID
```
    The SummaryInformation's section's format ID.
  - DOCUMENT_SUMMARY_INFORMATION_ID
```
public static final byte[][] DOCUMENT_SUMMARY_INFORMATION_ID
```
    The DocumentSummaryInformation's first and second sections' format ID.
  - UNDEFINED
```
public static final java.lang.String UNDEFINED
```
    A property without a known name is described by this string.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SectionIDMap
```
public SectionIDMap()
```
- Method Detail
  - getInstance
```
public static SectionIDMap getInstance()
```
    Returns the singleton instance of the default SectionIDMap.
    
    Returns:
    The instance value
  - getPIDString
```
public static java.lang.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 name space of property ID strings and thus must be specified.
    pid - The property ID
    
    Returns:
    The well-known property ID string associated with the property ID pid in the name space spanned by sectionFormatID . If the pid /sectionFormatID combination is not well-known, the string "[undefined]" is returned.
  - get
```
public PropertyIDMap get(byte[] sectionFormatID)
```
    Returns the PropertyIDMap for a given section format ID.
    
    Parameters:
    sectionFormatID - the section format ID
    
    Returns:
    the property ID map
  - put
```
public PropertyIDMap put(byte[] sectionFormatID,
                PropertyIDMap propertyIDMap)
```
    Associates a section format ID with a PropertyIDMap.
    
    Parameters:
    sectionFormatID - the section format ID
    propertyIDMap - the property ID map
    
    Returns:
    as defined by Map.put(K, V)
  - put
```
protected PropertyIDMap put(java.lang.String key,
                PropertyIDMap value)
```
    Associates the string representation of a section format ID with a PropertyIDMap
    
    Parameters:
    key - the key of the PropertyIDMap
    value - the PropertyIDMap itself
    
    Returns:
    the previous PropertyIDMap stored under this key, or null if there wasn't one

Class SectionIDMap

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.HashMap

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Field Detail

SUMMARY_INFORMATION_ID

DOCUMENT_SUMMARY_INFORMATION_ID

UNDEFINED

Constructor Detail

SectionIDMap

Method Detail

getInstance

getPIDString

get

put

put