Class PropertyIDMap

java.lang.Object
java.util.AbstractMap<K,V>
java.util.HashMap
loci.poi.hpsf.wellknown.PropertyIDMap
All Implemented Interfaces:
Serializable, Cloneable, Map

public class PropertyIDMap extends 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.

Since:
2002-02-09
Version:
$Id: PropertyIDMap.java 489730 2006-12-22 19:18:16Z bayard $
Author:
Rainer Klute <klute@rainer-klute.de>
See Also:
  • Field Details

    • PID_TITLE

      public static final int PID_TITLE

      ID of the property that denotes the document's title

      See Also:
    • PID_SUBJECT

      public static final int PID_SUBJECT

      ID of the property that denotes the document's subject

      See Also:
    • PID_AUTHOR

      public static final int PID_AUTHOR

      ID of the property that denotes the document's author

      See Also:
    • PID_KEYWORDS

      public static final int PID_KEYWORDS

      ID of the property that denotes the document's keywords

      See Also:
    • PID_COMMENTS

      public static final int PID_COMMENTS

      ID of the property that denotes the document's comments

      See Also:
    • PID_TEMPLATE

      public static final int PID_TEMPLATE

      ID of the property that denotes the document's template

      See Also:
    • PID_LASTAUTHOR

      public static final int PID_LASTAUTHOR

      ID of the property that denotes the document's last author

      See Also:
    • PID_REVNUMBER

      public static final int PID_REVNUMBER

      ID of the property that denotes the document's revision number

      See Also:
    • PID_EDITTIME

      public static final int PID_EDITTIME

      ID of the property that denotes the document's edit time

      See Also:
    • PID_LASTPRINTED

      public static final int PID_LASTPRINTED

      ID of the property that denotes the date and time the document was last printed

      See Also:
    • PID_CREATE_DTM

      public static final int PID_CREATE_DTM

      ID of the property that denotes the date and time the document was created.

      See Also:
    • PID_LASTSAVE_DTM

      public static final int PID_LASTSAVE_DTM

      ID of the property that denotes the date and time the document was saved

      See Also:
    • PID_PAGECOUNT

      public static final int PID_PAGECOUNT

      ID of the property that denotes the number of pages in the document

      See Also:
    • PID_WORDCOUNT

      public static final int PID_WORDCOUNT

      ID of the property that denotes the number of words in the document

      See Also:
    • PID_CHARCOUNT

      public static final int PID_CHARCOUNT

      ID of the property that denotes the number of characters in the document

      See Also:
    • PID_THUMBNAIL

      public static final int PID_THUMBNAIL

      ID of the property that denotes the document's thumbnail

      See Also:
    • PID_APPNAME

      public static final int PID_APPNAME

      ID of the property that denotes the application that created the document

      See Also:
    • PID_SECURITY

      public static final int PID_SECURITY

      ID of the property that denotes whether read/write access to the document is allowed or whether is should be opened as read-only. It can have the following values:

      Value

      Description

      0

      No restriction

      2

      Read-only recommended

      4

      Read-only enforced

      See Also:
    • PID_DICTIONARY

      public static final int PID_DICTIONARY

      The entry is a dictionary.

      See Also:
    • PID_CODEPAGE

      public static final int PID_CODEPAGE

      The entry denotes a code page.

      See Also:
    • PID_CATEGORY

      public static final int PID_CATEGORY

      The entry is a string denoting the category the file belongs to, e.g. review, memo, etc. This is useful to find documents of same type.

      See Also:
    • PID_PRESFORMAT

      public static final int PID_PRESFORMAT

      Target format for power point presentation, e.g. 35mm, printer, video etc.

      See Also:
    • PID_BYTECOUNT

      public static final int PID_BYTECOUNT

      Number of bytes.

      See Also:
    • PID_LINECOUNT

      public static final int PID_LINECOUNT

      Number of lines.

      See Also:
    • PID_PARCOUNT

      public static final int PID_PARCOUNT

      Number of paragraphs.

      See Also:
    • PID_SLIDECOUNT

      public static final int PID_SLIDECOUNT

      Number of slides in a power point presentation.

      See Also:
    • PID_NOTECOUNT

      public static final int PID_NOTECOUNT

      Number of slides with notes.

      See Also:
    • PID_HIDDENCOUNT

      public static final int PID_HIDDENCOUNT

      Number of hidden slides.

      See Also:
    • PID_MMCLIPCOUNT

      public static final int PID_MMCLIPCOUNT

      Number of multimedia clips, e.g. sound or video.

      See Also:
    • PID_SCALE

      public static final int PID_SCALE

      This entry is set to -1 when scaling of the thumbnail is desired. Otherwise the thumbnail should be cropped.

      See Also:
    • PID_HEADINGPAIR

      public static final int PID_HEADINGPAIR

      This entry denotes an internally used property. It is a vector of variants consisting of pairs of a string (VT_LPSTR) and a number (VT_I4). The string is a heading name, and the number tells how many document parts are under that heading.

      See Also:
    • PID_DOCPARTS

      public static final int PID_DOCPARTS

      This entry contains the names of document parts (word: names of the documents in the master document, excel: sheet names, power point: slide titles, binder: document names).

      See Also:
    • PID_MANAGER

      public static final int PID_MANAGER

      This entry contains the name of the project manager.

      See Also:
    • PID_COMPANY

      public static final int PID_COMPANY

      This entry contains the company name.

      See Also:
    • PID_LINKSDIRTY

      public static final int PID_LINKSDIRTY

      If this entry is -1 the links are dirty and should be re-evaluated.

      See Also:
    • PID_MAX

      public static final int PID_MAX

      The highest well-known property ID. Applications are free to use higher values for custom purposes.

      See Also:
  • Constructor Details

    • PropertyIDMap

      public PropertyIDMap(int initialCapacity, float loadFactor)

      Creates a PropertyIDMap.

      Parameters:
      initialCapacity - The initial capacity as defined for HashMap
      loadFactor - The load factor as defined for HashMap
    • PropertyIDMap

      public PropertyIDMap(Map map)

      Creates a PropertyIDMap backed by another map.

      Parameters:
      map - The instance to be created is backed by this map.
  • Method Details

    • put

      public Object put(long id, 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 Object get(long 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(String[] args)

      For the most basic testing.

      Parameters:
      args - The command-line arguments