Class PropertyIDMap
- All Implemented Interfaces:
Serializable,Cloneable,Map
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object, V extends Object> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intID of the property that denotes the application that created the documentstatic final intID of the property that denotes the document's authorstatic final intNumber of bytes.static final intThe entry is a string denoting the category the file belongs to, e.g.static final intID of the property that denotes the number of characters in the documentstatic final intThe entry denotes a code page.static final intID of the property that denotes the document's commentsstatic final intThis entry contains the company name.static final intID of the property that denotes the date and time the document was created.static final intThe entry is a dictionary.static final intThis 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).static final intID of the property that denotes the document's edit timestatic final intThis entry denotes an internally used property.static final intNumber of hidden slides.static final intID of the property that denotes the document's keywordsstatic final intID of the property that denotes the document's last authorstatic final intID of the property that denotes the date and time the document was last printedstatic final intID of the property that denotes the date and time the document was savedstatic final intNumber of lines.static final intIf this entry is -1 the links are dirty and should be re-evaluated.static final intThis entry contains the name of the project manager.static final intThe highest well-known property ID.static final intNumber of multimedia clips, e.g.static final intNumber of slides with notes.static final intID of the property that denotes the number of pages in the documentstatic final intNumber of paragraphs.static final intTarget format for power point presentation, e.g.static final intID of the property that denotes the document's revision numberstatic final intThis entry is set to -1 when scaling of the thumbnail is desired.static final intID of the property that denotes whether read/write access to the document is allowed or whether is should be opened as read-only.static final intNumber of slides in a power point presentation.static final intID of the property that denotes the document's subjectstatic final intID of the property that denotes the document's templatestatic final intID of the property that denotes the document's thumbnailstatic final intID of the property that denotes the document's titlestatic final intID of the property that denotes the number of words in the document -
Constructor Summary
ConstructorsConstructorDescriptionPropertyIDMap(int initialCapacity, float loadFactor) Creates aPropertyIDMap.PropertyIDMap(Map map) Creates aPropertyIDMapbacked by another map. -
Method Summary
Modifier and TypeMethodDescriptionget(long id) Gets the ID string for an ID from thePropertyIDMap.static PropertyIDMapReturns the Document Summary Information properties singleton.static PropertyIDMapstatic voidFor the most basic testing.Puts a ID string for an ID into thePropertyIDMap.Methods inherited from class java.util.HashMap
clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, valuesMethods inherited from class java.util.AbstractMap
equals, hashCode, toString
-
Field Details
-
PID_TITLE
public static final int PID_TITLEID of the property that denotes the document's title
- See Also:
-
PID_SUBJECT
public static final int PID_SUBJECTID of the property that denotes the document's subject
- See Also:
-
PID_AUTHOR
public static final int PID_AUTHORID of the property that denotes the document's author
- See Also:
-
PID_KEYWORDS
public static final int PID_KEYWORDSID of the property that denotes the document's keywords
- See Also:
-
PID_COMMENTS
public static final int PID_COMMENTSID of the property that denotes the document's comments
- See Also:
-
PID_TEMPLATE
public static final int PID_TEMPLATEID of the property that denotes the document's template
- See Also:
-
PID_LASTAUTHOR
public static final int PID_LASTAUTHORID of the property that denotes the document's last author
- See Also:
-
PID_REVNUMBER
public static final int PID_REVNUMBERID of the property that denotes the document's revision number
- See Also:
-
PID_EDITTIME
public static final int PID_EDITTIMEID of the property that denotes the document's edit time
- See Also:
-
PID_LASTPRINTED
public static final int PID_LASTPRINTEDID 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_DTMID of the property that denotes the date and time the document was created.
- See Also:
-
PID_LASTSAVE_DTM
public static final int PID_LASTSAVE_DTMID of the property that denotes the date and time the document was saved
- See Also:
-
PID_PAGECOUNT
public static final int PID_PAGECOUNTID of the property that denotes the number of pages in the document
- See Also:
-
PID_WORDCOUNT
public static final int PID_WORDCOUNTID of the property that denotes the number of words in the document
- See Also:
-
PID_CHARCOUNT
public static final int PID_CHARCOUNTID of the property that denotes the number of characters in the document
- See Also:
-
PID_THUMBNAIL
public static final int PID_THUMBNAILID of the property that denotes the document's thumbnail
- See Also:
-
PID_APPNAME
public static final int PID_APPNAMEID of the property that denotes the application that created the document
- See Also:
-
PID_SECURITY
public static final int PID_SECURITYID 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_DICTIONARYThe entry is a dictionary.
- See Also:
-
PID_CODEPAGE
public static final int PID_CODEPAGEThe entry denotes a code page.
- See Also:
-
PID_CATEGORY
public static final int PID_CATEGORYThe 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_PRESFORMATTarget format for power point presentation, e.g. 35mm, printer, video etc.
- See Also:
-
PID_BYTECOUNT
public static final int PID_BYTECOUNTNumber of bytes.
- See Also:
-
PID_LINECOUNT
public static final int PID_LINECOUNTNumber of lines.
- See Also:
-
PID_PARCOUNT
public static final int PID_PARCOUNTNumber of paragraphs.
- See Also:
-
PID_SLIDECOUNT
public static final int PID_SLIDECOUNTNumber of slides in a power point presentation.
- See Also:
-
PID_NOTECOUNT
public static final int PID_NOTECOUNTNumber of slides with notes.
- See Also:
-
PID_HIDDENCOUNT
public static final int PID_HIDDENCOUNTNumber of hidden slides.
- See Also:
-
PID_MMCLIPCOUNT
public static final int PID_MMCLIPCOUNTNumber of multimedia clips, e.g. sound or video.
- See Also:
-
PID_SCALE
public static final int PID_SCALEThis 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_HEADINGPAIRThis 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_DOCPARTSThis 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_MANAGERThis entry contains the name of the project manager.
- See Also:
-
PID_COMPANY
public static final int PID_COMPANYThis entry contains the company name.
- See Also:
-
PID_LINKSDIRTY
public static final int PID_LINKSDIRTYIf this entry is -1 the links are dirty and should be re-evaluated.
- See Also:
-
PID_MAX
public static final int PID_MAXThe 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. -
PropertyIDMap
Creates a
PropertyIDMapbacked by another map.- Parameters:
map- The instance to be created is backed by this map.
-
-
Method Details
-
put
Puts a ID string for an ID into the
PropertyIDMap.- Parameters:
id- The ID.idString- The ID string.- Returns:
- As specified by the
Mapinterface, this method returns the previous value associated with the specified id, ornullif there was no mapping for key.
-
get
Gets the ID string for an ID from the
PropertyIDMap.- Parameters:
id- The ID.- Returns:
- The ID string associated with id.
-
getSummaryInformationProperties
- Returns:
- the Summary Information properties singleton
-
getDocumentSummaryInformationProperties
Returns the Document Summary Information properties singleton.
- Returns:
- The Document Summary Information properties singleton.
-
main
For the most basic testing.
- Parameters:
args- The command-line arguments
-