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 mapping property IDs 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 use a HashMap delegate instead of extending HashMap and would require a lot of stupid typing, I won't do it for the time being.

Since:
2002-02-09
Version:
$Id: PropertyIDMap.java,v 1.4 2002/05/11 14:47:24 acoliver Exp $
Author:
Rainer Klute (klute@rainer-klute.de)
See Also:
Serialized Form

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

PID_SUBJECT

public static final int PID_SUBJECT
Description of the Field

PID_AUTHOR

public static final int PID_AUTHOR
Description of the Field

PID_KEYWORDS

public static final int PID_KEYWORDS
Description of the Field

PID_COMMENTS

public static final int PID_COMMENTS
Description of the Field

PID_TEMPLATE

public static final int PID_TEMPLATE
Description of the Field

PID_LASTAUTHOR

public static final int PID_LASTAUTHOR
Description of the Field

PID_REVNUMBER

public static final int PID_REVNUMBER
Description of the Field

PID_EDITTIME

public static final int PID_EDITTIME
Description of the Field

PID_LASTPRINTED

public static final int PID_LASTPRINTED
Description of the Field

PID_CREATE_DTM

public static final int PID_CREATE_DTM
Description of the Field

PID_LASTSAVE_DTM

public static final int PID_LASTSAVE_DTM
Description of the Field

PID_PAGECOUNT

public static final int PID_PAGECOUNT
Description of the Field

PID_WORDCOUNT

public static final int PID_WORDCOUNT
Description of the Field

PID_CHARCOUNT

public static final int PID_CHARCOUNT
Description of the Field

PID_THUMBNAIL

public static final int PID_THUMBNAIL
Description of the Field

PID_APPNAME

public static final int PID_APPNAME
Description of the Field

PID_SECURITY

public static final int PID_SECURITY
Description of the Field

PID_CATEGORY

public static final int PID_CATEGORY
Description of the Field

PID_PRESFORMAT

public static final int PID_PRESFORMAT
Description of the Field

PID_BYTECOUNT

public static final int PID_BYTECOUNT
Description of the Field

PID_LINECOUNT

public static final int PID_LINECOUNT
Description of the Field

PID_PARCOUNT

public static final int PID_PARCOUNT
Description of the Field

PID_SLIDECOUNT

public static final int PID_SLIDECOUNT
Description of the Field

PID_NOTECOUNT

public static final int PID_NOTECOUNT
Description of the Field

PID_HIDDENCOUNT

public static final int PID_HIDDENCOUNT
Description of the Field

PID_MMCLIPCOUNT

public static final int PID_MMCLIPCOUNT
Description of the Field

PID_SCALE

public static final int PID_SCALE
Description of the Field

PID_HEADINGPAIR

public static final int PID_HEADINGPAIR
Description of the Field

PID_DOCPARTS

public static final int PID_DOCPARTS
Description of the Field

PID_MANAGER

public static final int PID_MANAGER
Description of the Field

PID_COMPANY

public static final int PID_COMPANY
Description of the Field

PID_LINKSDIRTY

public static final int PID_LINKSDIRTY
Description of the Field
Constructor Detail

PropertyIDMap

public PropertyIDMap(int initialCapacity,
                     float loadFactor)
Constructor for the PropertyIDMap object
Parameters:
initialCapacity - Description of the Parameter
loadFactor - Description of the Parameter
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:
Description of the Return Value

get

public java.lang.Object get(int id)

Gets the ID string for an ID from the PropertyIDMap.

Parameters:
id - The ID.
Returns:
Description of the Return Value

getSummaryInformationProperties

public static PropertyIDMap getSummaryInformationProperties()

Returns the Summary Information properties singleton.

Returns:
The summaryInformationProperties value

getDocumentSummaryInformationProperties

public static PropertyIDMap getDocumentSummaryInformationProperties()

Returns the Summary Information properties singleton.

Returns:
The documentSummaryInformationProperties value

main

public static void main(java.lang.String[] args)
Description of the Method
Parameters:
args - Description of the Parameter

jakarta-poi 1.7.0-dev

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