org.apache.poi.hpsf.wellknown
Class PropertyIDMap

java.lang.Object
  |
  +--java.util.AbstractMap
        |
        +--java.util.HashMap
              |
              +--org.apache.poi.hpsf.wellknown.PropertyIDMap
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable

public class PropertyIDMap
extends java.util.HashMap

This is a dictionary which maps property ID values to property ID strings.

The methods getSummaryInformationProperties() and getDocumentSummaryInformationProperties() return singleton PropertyIDMaps. An application that wants to extend these maps should treat them as unmodifiable, copy them and modifiy the copies.

FIXME: Make the singletons unmodifiable. However, since this requires to use a HashMap delegate instead of extending HashMap and thus requires a lot of stupid typing. I won't do that for the time being.

Since:
2002-02-09
Version:
$Id: PropertyIDMap.java,v 1.5 2002/07/30 14:56:02 klute Exp $
Author:
Rainer Klute (klute@rainer-klute.de)
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class java.util.Map
java.util.Map.Entry
 
Field Summary
static int PID_APPNAME
           
static int PID_AUTHOR
           
static int PID_BYTECOUNT
           
static int PID_CATEGORY
           
static int PID_CHARCOUNT
           
static int PID_COMMENTS
           
static int PID_COMPANY
           
static int PID_CREATE_DTM
           
static int PID_DOCPARTS
           
static int PID_EDITTIME
           
static int PID_HEADINGPAIR
           
static int PID_HIDDENCOUNT
           
static int PID_KEYWORDS
           
static int PID_LASTAUTHOR
           
static int PID_LASTPRINTED
           
static int PID_LASTSAVE_DTM
           
static int PID_LINECOUNT
           
static int PID_LINKSDIRTY
           
static int PID_MANAGER
           
static int PID_MMCLIPCOUNT
           
static int PID_NOTECOUNT
           
static int PID_PAGECOUNT
           
static int PID_PARCOUNT
           
static int PID_PRESFORMAT
           
static int PID_REVNUMBER
           
static int PID_SCALE
           
static int PID_SECURITY
           
static int PID_SLIDECOUNT
           
static int PID_SUBJECT
           
static int PID_TEMPLATE
           
static int PID_THUMBNAIL
           
static int PID_TITLE
           
static int PID_WORDCOUNT
           
 
Constructor Summary
PropertyIDMap(int initialCapacity, float loadFactor)
          Creates a PropertyIDMap.
 
Method Summary
 java.lang.Object get(int id)
          Gets the ID string for an ID from the PropertyIDMap.
static PropertyIDMap getDocumentSummaryInformationProperties()
          Returns the Document Summary Information properties singleton.
static PropertyIDMap getSummaryInformationProperties()
          Returns the Summary Information properties singleton.
static void main(java.lang.String[] args)
          For the most basic testing.
 java.lang.Object put(int id, java.lang.String idString)
          Puts a ID string for an ID into the 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

PID_TITLE

public static final int PID_TITLE
See Also:
Constant Field Values

PID_SUBJECT

public static final int PID_SUBJECT
See Also:
Constant Field Values

PID_AUTHOR

public static final int PID_AUTHOR
See Also:
Constant Field Values

PID_KEYWORDS

public static final int PID_KEYWORDS
See Also:
Constant Field Values

PID_COMMENTS

public static final int PID_COMMENTS
See Also:
Constant Field Values

PID_TEMPLATE

public static final int PID_TEMPLATE
See Also:
Constant Field Values

PID_LASTAUTHOR

public static final int PID_LASTAUTHOR
See Also:
Constant Field Values

PID_REVNUMBER

public static final int PID_REVNUMBER
See Also:
Constant Field Values

PID_EDITTIME

public static final int PID_EDITTIME
See Also:
Constant Field Values

PID_LASTPRINTED

public static final int PID_LASTPRINTED
See Also:
Constant Field Values

PID_CREATE_DTM

public static final int PID_CREATE_DTM
See Also:
Constant Field Values

PID_LASTSAVE_DTM

public static final int PID_LASTSAVE_DTM
See Also:
Constant Field Values

PID_PAGECOUNT

public static final int PID_PAGECOUNT
See Also:
Constant Field Values

PID_WORDCOUNT

public static final int PID_WORDCOUNT
See Also:
Constant Field Values

PID_CHARCOUNT

public static final int PID_CHARCOUNT
See Also:
Constant Field Values

PID_THUMBNAIL

public static final int PID_THUMBNAIL
See Also:
Constant Field Values

PID_APPNAME

public static final int PID_APPNAME
See Also:
Constant Field Values

PID_SECURITY

public static final int PID_SECURITY
See Also:
Constant Field Values

PID_CATEGORY

public static final int PID_CATEGORY
See Also:
Constant Field Values

PID_PRESFORMAT

public static final int PID_PRESFORMAT
See Also:
Constant Field Values

PID_BYTECOUNT

public static final int PID_BYTECOUNT
See Also:
Constant Field Values

PID_LINECOUNT

public static final int PID_LINECOUNT
See Also:
Constant Field Values

PID_PARCOUNT

public static final int PID_PARCOUNT
See Also:
Constant Field Values

PID_SLIDECOUNT

public static final int PID_SLIDECOUNT
See Also:
Constant Field Values

PID_NOTECOUNT

public static final int PID_NOTECOUNT
See Also:
Constant Field Values

PID_HIDDENCOUNT

public static final int PID_HIDDENCOUNT
See Also:
Constant Field Values

PID_MMCLIPCOUNT

public static final int PID_MMCLIPCOUNT
See Also:
Constant Field Values

PID_SCALE

public static final int PID_SCALE
See Also:
Constant Field Values

PID_HEADINGPAIR

public static final int PID_HEADINGPAIR
See Also:
Constant Field Values

PID_DOCPARTS

public static final int PID_DOCPARTS
See Also:
Constant Field Values

PID_MANAGER

public static final int PID_MANAGER
See Also:
Constant Field Values

PID_COMPANY

public static final int PID_COMPANY
See Also:
Constant Field Values

PID_LINKSDIRTY

public static final int PID_LINKSDIRTY
See Also:
Constant Field Values
Constructor Detail

PropertyIDMap

public PropertyIDMap(int initialCapacity,
                     float loadFactor)

Creates a PropertyIDMap.

Method Detail

put

public java.lang.Object put(int id,
                            java.lang.String idString)

Puts a ID string for an ID into the PropertyIDMap.

Parameters:
id - The ID.
idString - The ID string.
Returns:
As specified by the Map interface, this method returns the previous value associated with the specified id, or null if there was no mapping for key.

get

public java.lang.Object get(int id)

Gets the ID string for an ID from the PropertyIDMap.

Parameters:
id - The ID.
Returns:
The ID string associated with id.

getSummaryInformationProperties

public static PropertyIDMap getSummaryInformationProperties()

Returns the Summary Information properties singleton.


getDocumentSummaryInformationProperties

public static PropertyIDMap getDocumentSummaryInformationProperties()

Returns the Document Summary Information properties singleton.

Returns:
The Document Summary Information properties singleton.

main

public static void main(java.lang.String[] args)

For the most basic testing.


jakarta-poi 1.8.0-dev

Copyright © 2002 Apache jakarta-poi project. All Rights Reserved.