Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hpsf.wellknown
Class SectionIDMap

    java.lang.Object
      org.apache.poi.hpsf.wellknown.SectionIDMap

    @Internal
    public class SectionIDMap

extends java.lang.Object

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

### SUMMARY_INFORMATION_ID

    public static final ClassID SUMMARY_INFORMATION_ID

  The SummaryInformation's section's format ID.

### DOCUMENT_SUMMARY_INFORMATION_ID

    public static final ClassID[] DOCUMENT_SUMMARY_INFORMATION_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(ClassID 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(ClassID 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(ClassID 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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.