Interface Office
public interface Office
Office Document properties collection. These properties apply to
Office / Productivity Documents of all forms, including (but not limited
to) MS Office and OpenDocument formats.
This is a logical collection of properties, which may be drawn from a
few different external definitions.
- Since:
- Apache Tika 1.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final PropertyName of the principal author(s) of a documentstatic final PropertyThe number of Characters in the documentstatic final PropertyThe number of Characters in the document, including spacesstatic final Propertystatic final PropertyWhen was the document created?static final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final Propertystatic final PropertyThe number of Images in the documentstatic final PropertyName of the initial creator/author of a documentstatic final PropertyKeywords pertaining to a document.static final PropertyName of the last (most recent) author of a documentstatic final PropertyThe number of lines in the documentstatic final Stringstatic final Propertystatic final Propertystatic final PropertyThe number of Objects in the document.static final Propertystatic final PropertyThe number of Pages are there in the (paged) documentstatic final PropertyThe number of individual Paragraphs in the documentstatic final Stringstatic final PropertyWhen was the document last printed?static final PropertyEmbedded files may have a "progID" associated with them, such as Word.Document.12 or AcroExch.Document.DCstatic final Propertystatic final PropertyWhen was the document last saved?static final Property1-based sheet number for a resource (e.g. an embedded image) anchored to exactly one sheet of a workbook.static final Property1-based sheet numbers a resource is anchored to, as a sequence.static final PropertyThe number of Slides are there in the (presentation) documentstatic final PropertyThe number of Tables in the documentstatic final intSentinel value used as the sole element ofSHEET_NUMBERSwhen an embedded resource is present in a workbook but not referenced from any sheet.static final Propertystatic final StringFor user defined metadata entries in the document, what prefix should be attached to the key names. eg invalid input: '<'meta:user-defined meta:name="Info1">Text1invalid input: '<'/meta:user-defined> becomes custom:Info1=Text1static final Propertystatic final PropertyThe number of Words in the documentstatic final Property
-
Field Details
-
NAMESPACE_URI_DOC_META
- See Also:
-
PREFIX_DOC_META
- See Also:
-
USER_DEFINED_METADATA_NAME_PREFIX
For user defined metadata entries in the document, what prefix should be attached to the key names. eg invalid input: '<'meta:user-defined meta:name="Info1">Text1invalid input: '<'/meta:user-defined> becomes custom:Info1=Text1- See Also:
-
KEYWORDS
Keywords pertaining to a document. Also populatesDublinCore.SUBJECT. -
INITIAL_AUTHOR
Name of the initial creator/author of a document -
LAST_AUTHOR
Name of the last (most recent) author of a document -
AUTHOR
Name of the principal author(s) of a document -
CREATION_DATE
When was the document created? -
SAVE_DATE
When was the document last saved? -
PRINT_DATE
When was the document last printed? -
SLIDE_COUNT
The number of Slides are there in the (presentation) document -
PAGE_COUNT
The number of Pages are there in the (paged) document -
PARAGRAPH_COUNT
The number of individual Paragraphs in the document -
LINE_COUNT
The number of lines in the document -
WORD_COUNT
The number of Words in the document -
CHARACTER_COUNT
The number of Characters in the document -
CHARACTER_COUNT_WITH_SPACES
The number of Characters in the document, including spaces -
TABLE_COUNT
The number of Tables in the document -
IMAGE_COUNT
The number of Images in the document -
OBJECT_COUNT
The number of Objects in the document. These are typically non-Image resources embedded in the document, such as other documents or non-Image media. -
PROG_ID
Embedded files may have a "progID" associated with them, such as Word.Document.12 or AcroExch.Document.DC -
OCX_NAME
-
EMBEDDED_STORAGE_CLASS_ID
-
HAS_HIDDEN_SHEETS
-
HAS_HIDDEN_COLUMNS
-
HAS_HIDDEN_ROWS
-
HAS_VERY_HIDDEN_SHEETS
-
HIDDEN_SHEET_NAMES
-
VERY_HIDDEN_SHEET_NAMES
-
PROTECTED_WORKSHEET
-
WORKBOOK_CODENAME
-
HAS_DATA_CONNECTIONS
-
HAS_EXTERNAL_LINKS
-
HAS_WEB_QUERIES
-
HAS_EXTERNAL_OLE_OBJECTS
-
HAS_FIELD_HYPERLINKS
-
HAS_HOVER_HYPERLINKS
-
HAS_VML_HYPERLINKS
-
HAS_COMMENTS
-
COMMENT_PERSONS
-
HAS_HIDDEN_SLIDES
-
NUM_HIDDEN_SLIDES
-
HAS_ANIMATIONS
-
NUM_UNLISTED_SLIDES
-
UNLISTED_SLIDE_NAMES
-
HAS_HIDDEN_TEXT
-
HAS_TRACK_CHANGES
-
HAS_DDE_LINKS
-
HAS_MAIL_MERGE
-
HAS_ATTACHED_TEMPLATE
-
HAS_SUBDOCUMENTS
-
HAS_EXTERNAL_PIVOT_DATA
-
HAS_POWER_QUERY
-
HAS_LINKED_OLE_OBJECTS
-
HAS_EXTERNAL_CHART_DATA
-
HAS_FRAMESETS
-
SHEET_NUMBER
1-based sheet number for a resource (e.g. an embedded image) anchored to exactly one sheet of a workbook. For resources spanning multiple sheets seeSHEET_NUMBERS. This is the spreadsheet analogue ofTikaPagedText.PAGE_NUMBER— the convention is identical, but the property name reflects the domain (Excel sheets are not "pages" in the printer sense). -
SHEET_NUMBERS
1-based sheet numbers a resource is anchored to, as a sequence. Used for resources that appear on multiple sheets of a workbook. SeeTikaPagedText.PAGE_NUMBERSfor the full convention (single-page, multi-page, unlinked, unknown); the same rules apply here, withUNLINKED_SHEETas the "known unlinked" sentinel. -
UNLINKED_SHEET
static final int UNLINKED_SHEETSentinel value used as the sole element ofSHEET_NUMBERSwhen an embedded resource is present in a workbook but not referenced from any sheet. MirrorsTikaPagedText.UNLINKED_PAGE— negative because real sheet numbers are 1-based. SeePageAnchoringfor the helper that writes this convention.- See Also:
-