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

Class ContentDetail

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

Content detail composite

The Content detail block comprises the single data Group P.18. The block as a whole is non-repeating. It is not mandatory within the <Product> record, and is used only when there is a requirement to describe individual chapters or parts within a product in a fully structured way. The more usual ONIX practice is to send a table of contents as text, possibly in XHTML, in Group P.14.

When used, the block should normally contain at least one instance of <ContentItem>. It may be empty 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.

Reference name <ContentDetail>
Short tag <contentdetail>
Cardinality 0…1

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ContentDetail

      public ContentDetail()

    • ContentDetail

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

    • ifExists

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

    • contentItems

      public ListOfOnixComposite<ContentItem> contentItems()

      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.

      Jonix-Comment: this list may be empty