Package org.apache.poi.hpsf.wellknown
Class PropertyIDMap
java.lang.Object
org.apache.poi.hpsf.wellknown.PropertyIDMap
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 modify the
copies.
Trying to modify the map directly will cause exceptions
UnsupportedOperationException
to be thrown.-
Nested Class Summary
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
ID of the property that denotes the application that created the documentstatic final int
ID of the property that denotes the document's authorstatic final int
The Behavior property, if present, MUST have the property identifier 0x80000003, MUST NOT have a property name, and MUST have type VT_UI4 (0x0013).static final int
Number of bytes.static final int
The entry is a string denoting the category the file belongs to, e.g.static final int
The entry specifies an estimate of the number of characters in the document, including whitespace, as an integerstatic final int
ID of the property that denotes the number of characters in the documentstatic final int
The entry denotes a code page.static final int
ID of the property that denotes the document's commentsstatic final int
This entry contains the company name.static final int
This entry contains a string of the document status.static final int
This entry contains a string of the content type of the file.static final int
ID of the property that denotes the date and time the document was created.static final int
The entry is a dictionary.static final int
This entry contains the VBA digital signature for the VBA project embedded in the document.static final int
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).static final int
This entry contains a string of the document version, but normally should be emptystatic final int
ID of the property that denotes the document's edit timestatic final int
This entry denotes an internally used property.static final int
Number of hidden slides.static final int
This entry contains a boolean which marks if the User Defined Property Set has been updated outside of the Application, if so the hyperlinks should be updated on document load.static final int
ID of the property that denotes the document's keywordsstatic final int
This entry contains a string of the document language, but normally should be empty.static final int
ID of the property that denotes the document's last authorstatic final int
ID of the property that denotes the date and time the document was last printedstatic final int
ID of the property that denotes the date and time the document was savedstatic final int
Number of lines.static final int
If this entry is -1 the links are dirty and should be re-evaluated.static final int
The Locale property, if present, MUST have the property identifier 0x80000000, MUST NOT have a property name, and MUST have type VT_UI4 (0x0013).static final int
This entry contains the name of the project manager.static final int
The highest well-known property ID.static final int
Number of multimedia clips, e.g.static final int
Number of slides with notes.static final int
ID of the property that denotes the number of pages in the documentstatic final int
Number of paragraphs.static final int
Target format for power point presentation, e.g.static final int
ID of the property that denotes the document's revision numberstatic final int
This entry is set to -1 when scaling of the thumbnail is desired.static final int
ID 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 int
Number of slides in a power point presentation.static final int
ID of the property that denotes the document's subjectstatic final int
ID of the property that denotes the document's templatestatic final int
ID of the property that denotes the document's thumbnailstatic final int
ID of the property that denotes the document's titlestatic final int
This entry contains the version of the Application which wrote the Property set, stored with the two high order bytes having the major version number, and the two low order bytes the minor version number.static final int
ID of the property that denotes the number of words in the documentstatic final String
A property without a known name is described by this string. -
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
boolean
containsKey
(Object key) boolean
containsValue
(Object value) entrySet()
static PropertyIDMap
static PropertyIDMap
Returns a property map, which is only used as a fallback, i.e.static PropertyIDMap
boolean
isEmpty()
keySet()
static void
For the most basic testing.void
int
size()
values()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll
-
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_CCHWITHSPACES
public static final int PID_CCHWITHSPACESThe entry specifies an estimate of the number of characters in the document, including whitespace, as an integer- See Also:
-
PID_HYPERLINKSCHANGED
public static final int PID_HYPERLINKSCHANGEDThis entry contains a boolean which marks if the User Defined Property Set has been updated outside of the Application, if so the hyperlinks should be updated on document load.- See Also:
-
PID_VERSION
public static final int PID_VERSIONThis entry contains the version of the Application which wrote the Property set, stored with the two high order bytes having the major version number, and the two low order bytes the minor version number.- See Also:
-
PID_DIGSIG
public static final int PID_DIGSIGThis entry contains the VBA digital signature for the VBA project embedded in the document.- See Also:
-
PID_CONTENTTYPE
public static final int PID_CONTENTTYPEThis entry contains a string of the content type of the file.- See Also:
-
PID_CONTENTSTATUS
public static final int PID_CONTENTSTATUSThis entry contains a string of the document status.- See Also:
-
PID_LANGUAGE
public static final int PID_LANGUAGEThis entry contains a string of the document language, but normally should be empty.- See Also:
-
PID_DOCVERSION
public static final int PID_DOCVERSIONThis entry contains a string of the document version, but normally should be empty- 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. (This value is based on Office 12, earlier versions of Office had lower values)- See Also:
-
PID_LOCALE
public static final int PID_LOCALEThe Locale property, if present, MUST have the property identifier 0x80000000, MUST NOT have a property name, and MUST have type VT_UI4 (0x0013). If present, its value MUST be a valid language code identifier as specified in [MS-LCID]. Its value is selected in an implementation-specific manner.- See Also:
-
PID_BEHAVIOUR
public static final int PID_BEHAVIOURThe Behavior property, if present, MUST have the property identifier 0x80000003, MUST NOT have a property name, and MUST have type VT_UI4 (0x0013). A version 0 property set, indicated by the value 0x0000 for the Version field of the PropertySetStream packet, MUST NOT have a Behavior property. If the Behavior property is present, it MUST have one of the following values.- 0x00000000 = Property names are case-insensitive (default)
- 0x00000001 = Property names are case-sensitive.
- See Also:
-
UNDEFINED
A property without a known name is described by this string.- See Also:
-
-
Method Details
-
getSummaryInformationProperties
- Returns:
- the Summary Information properties singleton
-
getDocumentSummaryInformationProperties
- Returns:
- The Document Summary Information properties singleton.
-
getFallbackProperties
Returns a property map, which is only used as a fallback, i.e. if available, the correct map forDocumentSummaryInformation
orSummaryInformation
should be used. -
size
public int size() -
isEmpty
public boolean isEmpty() -
containsKey
- Specified by:
containsKey
in interfaceMap<Long,
String>
-
containsValue
- Specified by:
containsValue
in interfaceMap<Long,
String>
-
get
-
put
-
remove
-
putAll
-
clear
public void clear() -
keySet
-
values
-
entrySet
-
main
For the most basic testing.- Parameters:
args
- The command-line arguments
-