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

Class RelatedMaterial

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

Related material composite

The related material block covers data Groups P.22 and P.23, providing links to related works and related products. The block as a whole is optional and non-repeating.

None of the individual sections are mandatory within an occurrence of the block. However, in most circumstances, the block should contain at least one instance of <RelatedWork> or <RelatedProduct>. 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 information about related works and products.

Reference name <RelatedMaterial>
Short tag <relatedmaterial>
Cardinality 0…1

Technical notes about <RelatedMaterial> from the schema author: Block 5, container for elements providing links to closely-related products and works This tag may be included in the following composites:

Possible placements within ONIX message:
See Also:

  • Field Details

  • Constructor Details

    • RelatedMaterial

      public RelatedMaterial()

    • RelatedMaterial

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

    • ifExists

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

    • relatedWorks

      public ListOfOnixComposite<RelatedWork> relatedWorks()

      An optional group of data elements which together describe a work which has a specified relationship to the product described in the ONIX record. Repeatable in order to specify multiple works and their various relationships to the product.

      JONIX adds: this list may be empty

    • relatedProducts

      public ListOfOnixComposite<RelatedProduct> relatedProducts()

      An optional group of data elements which together describe a product which has a specified relationship to the product described in the ONIX record. The composite is repeatable in order to specify different products which each have a relationship to the product described.

      JONIX adds: this list may be empty