Package org.apache.tika.metadata

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 Details

    • NAMESPACE_URI_DOC_META

      static final String NAMESPACE_URI_DOC_META
      See Also:

    • PREFIX_DOC_META

      static final String PREFIX_DOC_META
      See Also:

    • USER_DEFINED_METADATA_NAME_PREFIX

      static final String 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:

    • USER_DEFINED

      static final KeyPrefix USER_DEFINED

    • KEYWORDS

      static final Property KEYWORDS
      Keywords pertaining to a document. Also populates DublinCore.SUBJECT.

    • INITIAL_AUTHOR

      static final Property INITIAL_AUTHOR
      Name of the initial creator/author of a document

    • LAST_AUTHOR

      static final Property LAST_AUTHOR
      Name of the last (most recent) author of a document

    • AUTHOR

      static final Property AUTHOR
      Name of the principal author(s) of a document

    • CREATION_DATE

      static final Property CREATION_DATE
      When was the document created?

    • SAVE_DATE

      static final Property SAVE_DATE
      When was the document last saved?

    • SLIDE_COUNT

      static final Property SLIDE_COUNT
      The number of Slides are there in the (presentation) document

    • PAGE_COUNT

      static final Property PAGE_COUNT
      The number of Pages are there in the (paged) document

    • PARAGRAPH_COUNT

      static final Property PARAGRAPH_COUNT
      The number of individual Paragraphs in the document

    • LINE_COUNT

      static final Property LINE_COUNT
      The number of lines in the document

    • WORD_COUNT

      static final Property WORD_COUNT
      The number of Words in the document

    • CHARACTER_COUNT

      static final Property CHARACTER_COUNT
      The number of Characters in the document

    • CHARACTER_COUNT_WITH_SPACES

      static final Property CHARACTER_COUNT_WITH_SPACES
      The number of Characters in the document, including spaces

    • TABLE_COUNT

      static final Property TABLE_COUNT
      The number of Tables in the document

    • IMAGE_COUNT

      static final Property IMAGE_COUNT
      The number of Images in the document

    • OBJECT_COUNT

      static final Property 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

      static final Property PROG_ID
      Embedded files may have a "progID" associated with them, such as Word.Document.12 or AcroExch.Document.DC

    • OCX_NAME

      static final Property OCX_NAME

    • EMBEDDED_STORAGE_CLASS_ID

      static final Property EMBEDDED_STORAGE_CLASS_ID

    • HAS_HIDDEN_SHEETS

      static final Property HAS_HIDDEN_SHEETS

    • HAS_HIDDEN_COLUMNS

      static final Property HAS_HIDDEN_COLUMNS

    • HAS_HIDDEN_ROWS

      static final Property HAS_HIDDEN_ROWS

    • HAS_VERY_HIDDEN_SHEETS

      static final Property HAS_VERY_HIDDEN_SHEETS

    • HIDDEN_SHEET_NAMES

      static final Property HIDDEN_SHEET_NAMES

    • VERY_HIDDEN_SHEET_NAMES

      static final Property VERY_HIDDEN_SHEET_NAMES

    • PROTECTED_WORKSHEET

      static final Property PROTECTED_WORKSHEET

    • WORKBOOK_CODENAME

      static final Property WORKBOOK_CODENAME

    • HAS_DATA_CONNECTIONS

      static final Property HAS_DATA_CONNECTIONS

    • HAS_WEB_QUERIES

      static final Property HAS_WEB_QUERIES

    • HAS_EXTERNAL_OLE_OBJECTS

      static final Property HAS_EXTERNAL_OLE_OBJECTS

    • HAS_COMMENTS

      static final Property HAS_COMMENTS

    • COMMENT_PERSONS

      static final Property COMMENT_PERSONS

    • HAS_HIDDEN_SLIDES

      static final Property HAS_HIDDEN_SLIDES

    • NUM_HIDDEN_SLIDES

      static final Property NUM_HIDDEN_SLIDES

    • HAS_ANIMATIONS

      static final Property HAS_ANIMATIONS

    • NUM_UNLISTED_SLIDES

      static final Property NUM_UNLISTED_SLIDES

    • UNLISTED_SLIDE_NAMES

      static final Property UNLISTED_SLIDE_NAMES

    • HAS_HIDDEN_TEXT

      static final Property HAS_HIDDEN_TEXT

    • HAS_TRACK_CHANGES

      static final Property HAS_TRACK_CHANGES

    • HAS_MAIL_MERGE

      static final Property HAS_MAIL_MERGE

    • HAS_ATTACHED_TEMPLATE

      static final Property HAS_ATTACHED_TEMPLATE

    • HAS_SUBDOCUMENTS

      static final Property HAS_SUBDOCUMENTS

    • HAS_EXTERNAL_PIVOT_DATA

      static final Property HAS_EXTERNAL_PIVOT_DATA

    • HAS_POWER_QUERY

      static final Property HAS_POWER_QUERY

    • HAS_LINKED_OLE_OBJECTS

      static final Property HAS_LINKED_OLE_OBJECTS

    • HAS_EXTERNAL_CHART_DATA

      static final Property HAS_EXTERNAL_CHART_DATA

    • HAS_FRAMESETS

      static final Property HAS_FRAMESETS

    • HAS_UNREFERENCED_PARTS

      static final Property HAS_UNREFERENCED_PARTS
      Security-relevant, best-effort: true when the OOXML package contains one or more declared parts that are NOT reachable from the package root through the OPC relationship graph. Office resolves content by following relationships, so such a part is dead weight to Office -- a place to hide bytes that a raw-ZIP reader (AV/DLP/CDR) can still see. Whether Tika parsed it depends on the parser: some discover parts by content type rather than by relationship (the SAX Word parser still extracts an unreferenced wordprocessingml part), so this flag says nothing about which bytes reached a parser.

      Purely structural: the part's bytes are never inspected, and its content type comes from [Content_Types].xml by extension or explicit override, never by sniffing. So smuggle.xml holding RTF is flagged exactly as an innocent orphan is, and expect false positives -- some producers leave stale customXml or media parts behind after an edit. (A part with NO declared content type is a different case: POI rejects the whole package at open, so it surfaces as a container exception, never here.)

      This is an informational signal, NOT a guarantee, and it is evadable (a payload referenced by a relationship type Tika ignores is still reachable and unflagged): per Tika's security model, Tika is not a security boundary and does not attempt to detect parser differentials.

      Set only for Word, Excel, PowerPoint and Visio OOXML (including macro-enabled variants). XPS links content by markup rather than relationships and is not checked. See UNREFERENCED_PART_NAMES for the part names.

    • UNREFERENCED_PART_NAMES

      static final Property UNREFERENCED_PART_NAMES
      The names of the parts flagged by HAS_UNREFERENCED_PARTS.

    • SHEET_NUMBER

      static final Property 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 see SHEET_NUMBERS. This is the spreadsheet analogue of TikaPagedText.PAGE_NUMBER — the convention is identical, but the property name reflects the domain (Excel sheets are not "pages" in the printer sense).

    • SHEET_NUMBERS

      static final Property 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. See TikaPagedText.PAGE_NUMBERS for the full convention (single-page, multi-page, unlinked, unknown); the same rules apply here, with UNLINKED_SHEET as the "known unlinked" sentinel.

    • UNLINKED_SHEET

      static final int UNLINKED_SHEET
      Sentinel value used as the sole element of SHEET_NUMBERS when an embedded resource is present in a workbook but not referenced from any sheet. Mirrors TikaPagedText.UNLINKED_PAGE — negative because real sheet numbers are 1-based. See PageAnchoring for the helper that writes this convention.
      See Also: