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

Class ReligiousText

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

Religious text composite

An optional, non-repeating, group of data elements which together describe features of the content of an edition of a religious text, and intended to meet the special needs of religious publishers and booksellers. The <ReligiousText> composite may carry either a <Bible> composite or a <ReligiousTextIdentifier> element accompanied by multiple repeats of the <ReligiousTextFeature> composite. This approach is adopted to enable other devotional texts to be included if need arises without requiring a new ONIX release.

Reference name <ReligiousText>
Short tag <religioustext>
Cardinality 0…1

This tag may be included in the following composites:

Possible placements within ONIX message:

See Also:

  • Field Details

  • Constructor Details

    • ReligiousText

      public ReligiousText()

    • ReligiousText

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

    • ifExists

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

    • religiousTextIdentifier

      public ReligiousTextIdentifier religiousTextIdentifier()

      An ONIX code indicating a religious text other than the Bible. Mandatory in each occurrence of the <ReligiousText> composite that does not include a <Bible> composite, and non-repeating.

      Jonix-Comment: this field is required

    • religiousTextFeatures

      public ListOfOnixDataCompositeWithKey<ReligiousTextFeature,JonixReligiousTextFeature,ReligiousTextFeatureTypes> religiousTextFeatures()

      A repeatable group of data elements which together specify and describe a feature of a religious text. Mandatory if and only if <ReligiousTextIdentifier> is present.

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

    • bible

      public Bible bible()

      A group of data elements which together describe features of an edition of the Bible or of a selected Biblical text. Mandatory in each occurrence of the <ReligiousText> composite that does not include a <ReligiousTextIdentifier> element, and non-repeating.

      Jonix-Comment: this field is optional