Package org.apache.tika.metadata

Interface TikaPagedText

public interface TikaPagedText
Metadata properties for paged text, metadata appropriate for an individual page (useful for embedded document handlers called on individual pages). Use PagedText where possible

  • Field Details

    • TIKA_PAGED_TEXT_PREFIX

      static final String TIKA_PAGED_TEXT_PREFIX
      See Also:

    • PAGE_NUMBER

      static final Property PAGE_NUMBER
      1-based page number for a specific page. Set when a resource is anchored to exactly one page; for resources spanning multiple pages see PAGE_NUMBERS.

    • PAGE_NUMBERS

      static final Property PAGE_NUMBERS
      1-based page numbers an embedded resource is anchored to, as a sequence. Used for resources that appear on multiple pages (e.g. a logo or a shared image referenced from several slides of a presentation, or an image embedded in multiple sheets of a workbook).

      Conventions:

      • Resource on a single page: PAGE_NUMBERS = [N] and PAGE_NUMBER = N are both set.
      • Resource on multiple pages: PAGE_NUMBERS = [N1, N2, ...]; PAGE_NUMBER is not set.
      • Resource present in the container but not referenced from any page (an "unlinked" or orphan resource): PAGE_NUMBERS = [-1] (see UNLINKED_PAGE). Distinguishes "we know this image is unanchored" from "this format has no page concept" (which leaves the property unset).
      • Format has no page concept, or per-page anchoring is unknown: both PAGE_NUMBER and PAGE_NUMBERS unset.

    • UNLINKED_PAGE

      static final int UNLINKED_PAGE
      Sentinel value used as the sole element of PAGE_NUMBERS when an embedded resource is present in a paginated container but not referenced from any page. Chosen because real page numbers are 1-based, so any negative value is out-of-band.
      See Also:

    • PAGE_ROTATION

      static final Property PAGE_ROTATION