Module jonix.onix3
Package com.tectonica.jonix.onix3

Class TextItem

java.lang.Object
com.tectonica.jonix.onix3.TextItem
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable
public class TextItem extends Object implements OnixComposite.OnixSuperComposite, Serializable

Text item composite

A group of data elements which are specific to text content. Optional, but exactly one of either the <TextItem> composite or the similar <AVItem> composite must occur in a <ContentItem> composite which describes a particular content item. (Similar composites may be defined for other media, and the occurrence of one of them will be mandatory in any <ContentItem> composite.)

Reference name <TextItem>
Short tag <textitem>
Cardinality 0…1

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • TextItem

      public TextItem()

    • TextItem

      public TextItem(Element element)

  • Method Details

    • _initialize

      public void _initialize()
      Description copied from interface: OnixComposite
      This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites
      Specified by:
      _initialize in interface OnixComposite

    • exists

      public boolean exists()
      Description copied from interface: OnixTag
      indicates whether this tag exists in the ONIX record
      Specified by:
      exists in interface OnixTag
      Returns:
      whether this tag (<TextItem> or <textitem>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<TextItem> action)

    • getXmlElement

      public Element getXmlElement()
      Description copied from interface: OnixComposite
      For advanced use-cases only.
      Specified by:
      getXmlElement in interface OnixComposite
      Returns:
      native representation of the XML element underlying to this tag

    • textItemType

      public TextItemType textItemType()

      An ONIX code which identifies the nature of a text item. Mandatory in each occurrence of the <TextItem> composite, and non-repeatable.

      Jonix-Comment: this field is required

    • numberOfPages

      public NumberOfPages numberOfPages()

      The page extent of a text item within a paginated product. Optional and non-repeating, but normally expected when the text item is being referenced as part of a structured table of contents.

      Jonix-Comment: this field is optional

    • textItemIdentifiers

      public ListOfOnixDataCompositeWithKey<TextItemIdentifier,JonixTextItemIdentifier,TextItemIdentifierTypes> textItemIdentifiers()

      A repeatable group of data elements which together define an identifier of a text item in accordance with a specified scheme. The composite is optional.

      Jonix-Comment: this list may be empty

    • pageRuns

      public ListOfOnixDataComposite<PageRun,JonixPageRun> pageRuns()

      A repeatable group of data elements which together define a run of contiguous pages on which a text item appears. The composite is optional, but may be repeated where the text item covers two or more separate page runs.

      Jonix-Comment: this list may be empty