Module jonix.onix2

Package com.tectonica.jonix.onix2

Class ReligiousTextFeature

java.lang.Object

com.tectonica.jonix.onix2.ReligiousTextFeature

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixReligiousTextFeature>, OnixComposite.OnixDataCompositeWithKey<JonixReligiousTextFeature,ReligiousTextFeatureTypes>, OnixTag, Serializable

public class ReligiousTextFeature
extends Object
implements OnixComposite.OnixDataCompositeWithKey<JonixReligiousTextFeature,ReligiousTextFeatureTypes>, Serializable

Religious text feature composite

A repeatable group of data elements which together specify and describe a feature of a religious text.

Reference name	<ReligiousTextFeature>
Short tag	<religioustextfeature>

This tag may be included in the following composites:

• <ReligiousText>

Possible placements within ONIX message:

• Product ⯈ ReligiousText ⯈ ReligiousTextFeature

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 ReligiousTextFeature	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
ReligiousTextFeature()
ReligiousTextFeature(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixReligiousTextFeature	asStruct()
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<ReligiousTextFeature> action)
ReligiousTextFeatureCode	religiousTextFeatureCode()	An ONIX code describing a feature specified in the associated <ReligiousTextFeatureType> element.
ReligiousTextFeatureDescription	religiousTextFeatureDescription()	Free text describing a feature that is not adequately defined by code values alone.
ReligiousTextFeatureType	religiousTextFeatureType()	An ONIX code specifying a feature described in the associated <ReligiousTextFeatureCode> element.
ReligiousTextFeatureTypes	structKey()

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 ReligiousTextFeature EMPTY

Constructor Details

ReligiousTextFeature

public ReligiousTextFeature()

ReligiousTextFeature

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

ifExists

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

religiousTextFeatureType

public ReligiousTextFeatureType religiousTextFeatureType()

An ONIX code specifying a feature described in the associated <ReligiousTextFeatureCode> element. Mandatory in each occurrence of the <ReligiousTextFeature> composite, and non-repeating.

Jonix-Comment: this field is required

religiousTextFeatureCode

public ReligiousTextFeatureCode religiousTextFeatureCode()

An ONIX code describing a feature specified in the associated <ReligiousTextFeatureType> element. Mandatory in each occurrence of the <ReligiousTextFeature> composite, and non-repeating.

Jonix-Comment: this field is required

religiousTextFeatureDescription

public ReligiousTextFeatureDescription religiousTextFeatureDescription()

Free text describing a feature that is not adequately defined by code values alone. Optional and non-repeating.

Jonix-Comment: this field is optional

asStruct

public JonixReligiousTextFeature asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixReligiousTextFeature>

structKey

public ReligiousTextFeatureTypes structKey()

Specified by:

structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixReligiousTextFeature,ReligiousTextFeatureTypes>