Module jonix.onix2
Package com.tectonica.jonix.onix2

Class ContentItem

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

Content item composite

A repeatable group of data elements which together describe a content item within a product.

Reference name <ContentItem>
Short tag <contentitem>

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ContentItem

      public ContentItem()

    • ContentItem

      public ContentItem(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 (<ContentItem> or <contentitem>) is explicitly provided in the ONIX XML

    • ifExists

      public void ifExists(Consumer<ContentItem> 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

    • textItem

      public TextItem textItem()

      A group of data elements which are specific to text content. The composite must occur once and only once in a <ContentItem> composite which describes a text content item. (Similar composites are being defined for other media, and the occurrence of one of them will be mandatory in any <ContentItem> composite.)

      Jonix-Comment: this field is required

    • componentTypeName

      public ComponentTypeName componentTypeName()

      The generic name (if any) which is given in the product to the type of section which the content item represents, eg Chapter, Part, Track. Optional and non-repeating; but either this field or a title (in <DistinctiveTitle> or in a <Title> composite) or both must be present in any occurrence of the <ContentItem> composite.

      Jonix-Comment: this field is required

    • levelSequenceNumber

      public LevelSequenceNumber levelSequenceNumber()

      A number which specifies the position of a content item in a multi-level hierarchy of such items. Numbering starts at the top level in the hierarchy, which may represent (eg) chapters in a printed book, and the first item at the top level is numbered 1. Numbers should be assigned solely with a view to the logic of the ONIX description and not in relation to any other characteristics of the items being numbered (such as their typographical layout in a printed table of contents). <LevelSequenceNumber> is not a required field, but it is strongly recommended for structured tables of contents. If used, it must occur once and only once in each occurrence of the <ContentItem> composite.

      Jonix-Comment: this field is optional

    • componentNumber

      public ComponentNumber componentNumber()

      The number (if any) which is given to the content item in the product, in the form (eg Arabic or roman) in which it is given in the product. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • distinctiveTitle

      public DistinctiveTitle distinctiveTitle()

      The distinctive title of a content item. Optional and non-repeating; but either this field (or a title in a <Title>composite) or a <ComponentTypeName> must be present in any occurrence of the <ContentItem> composite. The <Title> composite provides a more general method of handling all forms of title, and is to be preferred.

      Jonix-Comment: this field is optional

    • contributorStatement

      public ContributorStatement contributorStatement()

      Free text showing exactly how the authorship should be described in an online display, when a standard concatenation of individual contributor elements would not give a satisfactory presentation. When this field is sent, the receiving party is expected to use it to replace all names sent in the <Contributor> composite for display purposes only. It does not replace any biographical notes sent in the composite. The individual contributor elements must also be sent for indexing and retrieval.

      Jonix-Comment: this field is optional

    • websites

      public ListOfOnixDataComposite<Website,JonixWebsite> websites()

      A repeatable group of data elements which together identify and provide pointers to a website which is related to a content item.

      Jonix-Comment: this list may be empty

    • titles

      public ListOfOnixDataCompositeWithKey<Title,JonixTitle,TitleTypes> titles()

      A repeatable group of data elements which together give the text of a title of a content item and specify its type, used here to give alternate forms of title for a content item. Please see Group PR.7 for details.

      Jonix-Comment: this list may be empty

    • workIdentifiers

      public ListOfOnixDataCompositeWithKey<WorkIdentifier,JonixWorkIdentifier,WorkIdentifierTypes> workIdentifiers()

      A group of data elements which together define the identifier of a work which is manifested in the content item. Optional and repeatable. Please see Group PR.7 for details.

      Jonix-Comment: this list may be empty

    • contributors

      public ListOfOnixComposite<Contributor> contributors()

      A group of data elements which together describe a personal or corporate contributor to a content item. Optional and repeatable. Please see Group PR.8 for details.

      Jonix-Comment: this list may be empty

    • subjects

      public ListOfOnixDataComposite<Subject,JonixSubject> subjects()

      A repeatable group of data elements which together describe a subject of a content item. Please see Group PR.13 for details.

      Jonix-Comment: this list may be empty

    • personAsSubjects

      public ListOfOnixComposite<PersonAsSubject> personAsSubjects()

      A repeatable group of data elements which together identify a person as a subject of a content item. Please see Group PR.13 for details.

      Jonix-Comment: this list may be empty

    • corporateBodyAsSubjects

      public ListOfOnixElement<CorporateBodyAsSubject,String> corporateBodyAsSubjects()

      The name of a corporate body which is part of the subject of the content item. Optional, and repeatable if more than one corporate body is involved.

      Jonix-Comment: this list may be empty

    • placeAsSubjects

      public ListOfOnixElement<PlaceAsSubject,String> placeAsSubjects()

      The name of a place or region or geographical entity which is part of the subject of the content item. Optional, and repeatable if the subject of the content item includes more than one place.

      Jonix-Comment: this list may be empty

    • otherTexts

      public ListOfOnixDataCompositeWithKey<OtherText,JonixOtherText,OtherTextTypes> otherTexts()

      A repeatable group of data elements which together identify, and either include or provide pointers to, text related to a content item. Please see Group PR.15 for details.

      Jonix-Comment: this list may be empty

    • mediaFiles

      public ListOfOnixDataCompositeWithKey<MediaFile,JonixMediaFile,ImageAudioVideoFileTypes> mediaFiles()

      A repeatable group of data elements which together identify and provide pointers to an image, audio or video file related to a content item. Please see Group PR.16 for details.

      Jonix-Comment: this list may be empty