Save This Page
Home » poi-src-3.2-FINAL-20081019 » org.apache » poi » hpsf » wellknown » [javadoc | source]
org.apache.poi.hpsf.wellknown
public class: PropertyIDMap [javadoc | source]
java.lang.Object
   java.util.AbstractMap
      java.util.HashMap
         org.apache.poi.hpsf.wellknown.PropertyIDMap

All Implemented Interfaces:
    Map, Serializable, Cloneable

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

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

Field Summary
public static final  int PID_TITLE   

ID of the property that denotes the document's title

 
public static final  int PID_SUBJECT   

ID of the property that denotes the document's subject

 
public static final  int PID_AUTHOR   

ID of the property that denotes the document's author

 
public static final  int PID_KEYWORDS   

ID of the property that denotes the document's keywords

 
public static final  int PID_COMMENTS   

ID of the property that denotes the document's comments

 
public static final  int PID_TEMPLATE   

ID of the property that denotes the document's template

 
public static final  int PID_LASTAUTHOR   

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

 
public static final  int PID_REVNUMBER   

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

 
public static final  int PID_EDITTIME   

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

 
public static final  int PID_LASTPRINTED   

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

 
public static final  int PID_CREATE_DTM   

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

 
public static final  int PID_LASTSAVE_DTM   

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

 
public static final  int PID_PAGECOUNT   

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

 
public static final  int PID_WORDCOUNT   

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

 
public static final  int PID_CHARCOUNT   

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

 
public static final  int PID_THUMBNAIL   

ID of the property that denotes the document's thumbnail

 
public static final  int PID_APPNAME   

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

 
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

 
public static final  int PID_DICTIONARY   

The entry is a dictionary.

 
public static final  int PID_CODEPAGE   

The entry denotes a code page.

 
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.

 
public static final  int PID_PRESFORMAT   

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

 
public static final  int PID_BYTECOUNT   

Number of bytes.

 
public static final  int PID_LINECOUNT   

Number of lines.

 
public static final  int PID_PARCOUNT   

Number of paragraphs.

 
public static final  int PID_SLIDECOUNT   

Number of slides in a power point presentation.

 
public static final  int PID_NOTECOUNT   

Number of slides with notes.

 
public static final  int PID_HIDDENCOUNT   

Number of hidden slides.

 
public static final  int PID_MMCLIPCOUNT   

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

 
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.

 
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.

 
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).

 
public static final  int PID_MANAGER   

This entry contains the name of the project manager.

 
public static final  int PID_COMPANY   

This entry contains the company name.

 
public static final  int PID_LINKSDIRTY   

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

 
public static final  int PID_MAX   

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

 
Constructor:
 public PropertyIDMap(Map map) 
    Parameters:
    map - The instance to be created is backed by this map.
 public PropertyIDMap(int initialCapacity,
    float loadFactor) 
    Parameters:
    initialCapacity - The initial capacity as defined for HashMap
    loadFactor - The load factor as defined for HashMap
Method from org.apache.poi.hpsf.wellknown.PropertyIDMap Summary:
get,   getDocumentSummaryInformationProperties,   getSummaryInformationProperties,   main,   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.PropertyIDMap Detail:
 public Object get(long id) 
 public static PropertyIDMap getDocumentSummaryInformationProperties() 

    Returns the Document Summary Information properties singleton.

 public static PropertyIDMap getSummaryInformationProperties() 
 public static  void main(String[] args) 

    For the most basic testing.

 public Object put(long id,
    String idString)