Module jonix.onix2

Package com.tectonica.jonix.onix2

Class ReligiousText

java.lang.Object

com.tectonica.jonix.onix2.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 <ReligiousTextID> 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>

This tag may be included in the following composites:

• <Product>

Possible placements within ONIX message:

• Product ⯈ ReligiousText

Since:

Onix-2.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixComposite

OnixComposite.OnixDataComposite<V extends JonixStruct>, OnixComposite.OnixDataCompositeUncommon, OnixComposite.OnixDataCompositeWithKey<V extends JonixKeyedStruct<K>,K extends Enum<K> & OnixCodelist>, OnixComposite.OnixSuperComposite

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final ReligiousText	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration

Constructor Summary

Constructors

Constructor	Description
ReligiousText()
ReligiousText(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
Bible	bible()	A group of data elements which together describe features of an edition of the Bible or of a selected Biblical text.
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<ReligiousText> action)
ListOfOnixDataCompositeWithKey<ReligiousTextFeature,JonixReligiousTextFeature,ReligiousTextFeatureTypes>	religiousTextFeatures()	A repeatable group of data elements which together specify and describe a feature of a religious text.
ReligiousTextID	religiousTextID()	An ONIX code indicating a religious text other than the Bible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

EMPTY

public static final ReligiousText EMPTY

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

religiousTextID

public ReligiousTextID religiousTextID()

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 adds: 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.

JONIX adds: 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 <ReligiousTextID> element, and non-repeating.

JONIX adds: this field is optional