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

Class ContentItem

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

Content item composite

A group of data elements which together describe a content item within a product. Optional in any occurrence of the <ContentDetail> composite, but it may be omitted only within a partial or ‘block update’ (Notification or update type 04, see P.1.2) when the intention is to remove all previously supplied content detail. When used normally, it is repeatable for each content item within the product.

Reference name <ContentItem>
Short tag <contentitem>
Cardinality 0…n

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

    • 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 the <TitleDetail> composite), or both, must be present in each occurrence of the <ContentItem>.

      Jonix-Comment: this field is required

    • 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.

      Jonix-Comment: this list is required to contain at least one item

    • 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 actual numbering or their typographical layout in a printed table of contents). So for example, Chapter 2 could have a level sequence number of 3, and the second sub-section within Chapter 2 could be numbered 3.2. <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

    • textItem

      public TextItem textItem()

      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.)

      Jonix-Comment: this field is optional

    • avItem

      public AVItem avItem()

      An optional group of data elements which are specific to audio or audiovisual (ie time-based) content. Exactly one of either the <AVItem> composite or the similar <TextItem> composite must occur in a <ContentItem> composite which describes a content item.

      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

    • noContributor

      public NoContributor noContributor()

      An empty element that provides a positive indication that a content item has no stated authorship. Optional and non-repeating. Must only be sent in a <ContentItem> composite that has no <Contributor> elements.

      Jonix-Comment: this field is optional

    • isNoContributor

      public boolean isNoContributor()

    • epubUsageConstraints

      public ListOfOnixComposite<EpubUsageConstraint> epubUsageConstraints()

      An optional group of data elements which together describe a usage constraint on a content item within a digital product (or the absence of such a constraint), whether enforced by DRM technical protection, inherent in the platform used, or specified by license agreement. Repeatable in order to describe multiple constraints on usage.

      Jonix-Comment: this list may be empty

    • epubLicenses

      public ListOfOnixComposite<EpubLicenseWithDateType> epubLicenses()
      Jonix-Comment: this list may be empty

    • titleDetails

      public ListOfOnixComposite<TitleDetail> titleDetails()

      A repeatable group of data elements which together give the text of a title of a content item and specify its type. Optional.

      Jonix-Comment: this list may be empty

    • contributorStatements

      public ListOfOnixElement<ContributorStatement,String> contributorStatements()

      Free text showing how the authorship of a content item should be described in an online display, when a standard concatenation of individual contributor elements would not give a satisfactory presentation. Optional, and repeatable if parallel text is provided in multiple languages. The language attribute is optional for a single instance of <ContributorStatement>, but must be included in each instance if <ContributorStatement> is repeated. When the <ContributorStatement> field is sent, the receiver should use it to replace all name detail (though not the biographical, date or place details) sent in the <Contributor> composite for display purposes only. The individual name detail must also be sent in the <Contributor> composite for indexing and retrieval.

      Jonix-Comment: this list may be empty

    • languages

      public ListOfOnixDataCompositeWithKey<Language,JonixLanguage,LanguageRoles> languages()

      An optional and repeatable group of data elements which together represent a language, and specify its role and, where required, whether it is a country variant.

      Jonix-Comment: this list may be empty

    • subjects

      public ListOfOnixDataComposite<Subject,JonixSubject> subjects()

      A group of data elements which together specify a subject classification or a subject heading relating to a content item. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • nameAsSubjects

      public ListOfOnixComposite<NameAsSubject> nameAsSubjects()

      An optional and repeatable group of data elements which together represent the name of a person or organization – real or fictional – that is part of the subject of a content item.

      Jonix-Comment: this list may be empty

    • textContents

      public ListOfOnixComposite<TextContent> textContents()

      A group of data elements which together carry text related to a content item. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • citedContents

      public ListOfOnixComposite<CitedContent> citedContents()

      A group of data elements which together describe a piece of cited content. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • supportingResources

      public ListOfOnixComposite<SupportingResource> supportingResources()

      A group of data elements which together describe a supporting resource. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • publishers

      public ListOfOnixComposite<Publisher> publishers()

      A group of data elements which together identify an entity which is associated with the publishing of a content item, included here to allow roles such as Funder, Sponsor to be associated with a specific content item rather than the product as a whole. The composite allows additional publishing roles to be introduced without adding new fields. Each occurrence of the composite must carry a publishing role code and either a name identifier or a name or both. Optional, and repeatable in order to identify multiple entities.

      Jonix-Comment: this list may be empty

    • copyrightStatements

      public ListOfOnixComposite<CopyrightStatement> copyrightStatements()

      An optional and repeatable group of data elements which together represent a copyright or neighboring right statement for the content item. At least one <CopyrightYear> or one instance of the <CopyrightOwner> composite must be sent within an instance of the composite, but it is recommended that all elements in the composite are explicitly populated. The Copyright statement may be repeated to provide a full structured rights statement listing year(s) and rights holder(s).

      Jonix-Comment: this list may be empty

    • copyrightStatementTexts

      public ListOfOnixElement<CopyrightStatementText,String> copyrightStatementTexts()
      Jonix-Comment: this list may be empty

    • relatedWorks

      public ListOfOnixComposite<RelatedWork> relatedWorks()

      A group of data elements which together describe a work which has a specified relationship to a content item. Optional and repeatable.

      Jonix-Comment: this list may be empty

    • relatedProducts

      public ListOfOnixComposite<RelatedProduct> relatedProducts()

      A group of data elements which together describe a product which has a specified relationship to a content item. Optional and repeatable.

      Jonix-Comment: this list may be empty