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

Class AncillaryContent

java.lang.Object
com.tectonica.jonix.onix3.AncillaryContent
All Implemented Interfaces:
OnixComposite, OnixComposite.OnixDataComposite<JonixAncillaryContent>, OnixComposite.OnixDataCompositeWithKey<JonixAncillaryContent,IllustrationAndOtherContentTypes>, OnixTag, Serializable
public class AncillaryContent extends Object implements OnixComposite.OnixDataCompositeWithKey<JonixAncillaryContent,IllustrationAndOtherContentTypes>, Serializable

Ancillary content composite

A group of data elements which together specify the number of illustrations or other content items of a stated type which the product carries. Use of the <AncillaryContent> composite is optional, but is repeatable if necessary to specify different types of content items.

Reference name <AncillaryContent>
Short tag <ancillarycontent>
Cardinality 0…n

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • AncillaryContent

      public AncillaryContent()

    • AncillaryContent

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

    • ifExists

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

    • ancillaryContentType

      public AncillaryContentType ancillaryContentType()

      An ONIX code which identifies the type of illustration or other content to which an occurrence of the composite refers. Mandatory in each occurrence of the <AncillaryContent> composite, and non-repeating.

      Jonix-Comment: this field is required

    • number

      public Number number()

      The number of illustrations or other content items of the type specified in <AncillaryContentType>. Optional and non-repeating.

      Jonix-Comment: this field is optional

    • ancillaryContentDescriptions

      public ListOfOnixElement<AncillaryContentDescription,String> ancillaryContentDescriptions()

      Text describing the type of illustration or other content to which an occurrence of the composite refers, when a code is insufficient. Optional, and repeatable if parallel descriptive text is provided in multiple languages. Required when <AncillaryContentType> carries the value 00. The language attribute is optional for a single instance of <AncillaryContentDescription>, but must be included in each instance if <AncillaryContentDescription> is repeated.

      Jonix-Comment: this list may be empty

    • asStruct

      public JonixAncillaryContent asStruct()
      Specified by:
      asStruct in interface OnixComposite.OnixDataComposite<JonixAncillaryContent>

    • structKey

      public IllustrationAndOtherContentTypes structKey()
      Specified by:
      structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixAncillaryContent,IllustrationAndOtherContentTypes>