org.apache.poi.hpsf.wellknown: public class: SectionIDMap

org.apache.poi.hpsf.wellknown
public class: SectionIDMap [javadoc | source]

java.lang.Object
   java.util.AbstractMap
      java.util.HashMap
         org.apache.poi.hpsf.wellknown.SectionIDMap

All Implemented Interfaces:
Map, Serializable, Cloneable

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 -

Field Summary
public static final byte[]	SUMMARY_INFORMATION_ID	The SummaryInformation's section's format ID.
public static final byte[][]	DOCUMENT_SUMMARY_INFORMATION_ID	The DocumentSummaryInformation's first and second sections' format ID.
public static final String	UNDEFINED	A property without a known name is described by this string.

Method from org.apache.poi.hpsf.wellknown.SectionIDMap Summary:
get, get, getInstance, getPIDString, put, put

Methods from java.util.HashMap:
clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods from java.util.AbstractMap:
clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.poi.hpsf.wellknown.SectionIDMap Detail:
public PropertyIDMap get(byte[] sectionFormatID) { return (PropertyIDMap) super.get(new String(sectionFormatID)); } Returns the PropertyIDMap for a given section format ID.
public Object get(Object sectionFormatID) { return get((byte[]) sectionFormatID); } Deprecated! `Use` - #get(byte[]) instead! Returns the PropertyIDMap for a given section format ID.
public static SectionIDMap getInstance() { if (defaultMap == null) { final SectionIDMap m = new SectionIDMap(); m.put(SUMMARY_INFORMATION_ID, PropertyIDMap.getSummaryInformationProperties()); m.put(DOCUMENT_SUMMARY_INFORMATION_ID[0], PropertyIDMap.getDocumentSummaryInformationProperties()); defaultMap = m; } return defaultMap; } Returns the singleton instance of the default SectionIDMap .
public static String getPIDString(byte[] sectionFormatID, long pid) { final PropertyIDMap m = getInstance().get(sectionFormatID); if (m == null) return UNDEFINED; else { final String s = (String) m.get(pid); if (s == null) return UNDEFINED; return s; } } Returns the property ID string that is associated with a given property ID in a section format ID's namespace.
public Object put(byte[] sectionFormatID, PropertyIDMap propertyIDMap) { return super.put(new String(sectionFormatID), propertyIDMap); } Associates a section format ID with a PropertyIDMap .
public Object put(Object key, Object value) { return put((byte[]) key, (PropertyIDMap) value); } Deprecated! `Use` - #put(byte[], PropertyIDMap) instead!

Method from org.apache.poi.hpsf.wellknown.SectionIDMap Detail:

 public PropertyIDMap get(byte[] sectionFormatID) {
        return (PropertyIDMap) super.get(new String(sectionFormatID));
}

Returns the PropertyIDMap for a given section format ID.

 public Object get(Object sectionFormatID) {
        return get((byte[]) sectionFormatID);
}

Deprecated! Use - #get(byte[]) instead!

Returns the PropertyIDMap for a given section format ID.

 public static SectionIDMap getInstance() {
                      
        if (defaultMap == null)
        {
            final SectionIDMap m = new SectionIDMap();
            m.put(SUMMARY_INFORMATION_ID,
                  PropertyIDMap.getSummaryInformationProperties());
            m.put(DOCUMENT_SUMMARY_INFORMATION_ID[0],
                  PropertyIDMap.getDocumentSummaryInformationProperties());
            defaultMap = m;
        }
        return defaultMap;
}

Returns the singleton instance of the default SectionIDMap .

 public static String getPIDString(byte[] sectionFormatID,
    long pid) {
        final PropertyIDMap m = getInstance().get(sectionFormatID);
        if (m == null)
            return UNDEFINED;
        else
        {
            final String s = (String) m.get(pid);
            if (s == null)
                return UNDEFINED;
            return s;
        }
}

Returns the property ID string that is associated with a given property ID in a section format ID's namespace.

 public Object put(byte[] sectionFormatID,
    PropertyIDMap propertyIDMap) {
        return super.put(new String(sectionFormatID), propertyIDMap);
}

Associates a section format ID with a PropertyIDMap .

 public Object put(Object key,
    Object value) {
        return put((byte[]) key, (PropertyIDMap) value);
}

Deprecated! Use - #put(byte[], PropertyIDMap) instead!