com.tectonica.jonix.onix2.Bible Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jonix-onix2 Show documentation
Show all versions of jonix-onix2 Show documentation
Collection of classes for processing Onix-2 sources
/*
* Copyright (C) 2012-2023 Zach Melamed
*
* Latest version available online at https://github.com/zach-m/jonix
* Contact me at [email protected]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tectonica.jonix.onix2;
import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.ListOfOnixCodelist;
import com.tectonica.jonix.common.OnixComposite.OnixDataComposite;
import com.tectonica.jonix.common.codelist.BibleContentss;
import com.tectonica.jonix.common.codelist.BiblePurposes;
import com.tectonica.jonix.common.codelist.BibleTextFeatures;
import com.tectonica.jonix.common.codelist.BibleVersions;
import com.tectonica.jonix.common.codelist.Languages;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;
import com.tectonica.jonix.common.codelist.TextCaseFlags;
import com.tectonica.jonix.common.codelist.TextFormats;
import com.tectonica.jonix.common.codelist.TransliterationSchemes;
import com.tectonica.jonix.common.struct.JonixBible;
import java.io.Serializable;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Bible composite
*
* 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.
*
*
*
* Reference name
* <Bible>
*
*
* Short tag
* <bible>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link ReligiousText}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link ReligiousText} ⯈ {@link Bible}
*
*
* @since Onix-2.1
*/
public class Bible implements OnixDataComposite, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "Bible";
public static final String shortname = "bible";
/////////////////////////////////////////////////////////////////////////////////
// ATTRIBUTES
/////////////////////////////////////////////////////////////////////////////////
public TextFormats textformat;
public TextCaseFlags textcase;
public Languages language;
public TransliterationSchemes transliteration;
/**
* (type: DateOrDateTime)
*/
public String datestamp;
public RecordSourceTypes sourcetype;
public String sourcename;
/////////////////////////////////////////////////////////////////////////////////
// CONSTRUCTION
/////////////////////////////////////////////////////////////////////////////////
private boolean initialized;
private final boolean exists;
private final org.w3c.dom.Element element;
public static final Bible EMPTY = new Bible();
public Bible() {
exists = false;
element = null;
initialized = true; // so that no further processing will be done on this intentionally-empty object
}
public Bible(org.w3c.dom.Element element) {
exists = true;
initialized = false;
this.element = element;
textformat = TextFormats.byCode(JPU.getAttribute(element, "textformat"));
textcase = TextCaseFlags.byCode(JPU.getAttribute(element, "textcase"));
language = Languages.byCode(JPU.getAttribute(element, "language"));
transliteration = TransliterationSchemes.byCode(JPU.getAttribute(element, "transliteration"));
datestamp = JPU.getAttribute(element, "datestamp");
sourcetype = RecordSourceTypes.byCode(JPU.getAttribute(element, "sourcetype"));
sourcename = JPU.getAttribute(element, "sourcename");
}
@Override
public void _initialize() {
if (initialized) {
return;
}
initialized = true;
JPU.forElementsOf(element, e -> {
final String name = e.getNodeName();
switch (name) {
case BibleContents.refname:
case BibleContents.shortname:
bibleContentss = JPU.addToList(bibleContentss, new BibleContents(e));
break;
case BibleVersion.refname:
case BibleVersion.shortname:
bibleVersions = JPU.addToList(bibleVersions, new BibleVersion(e));
break;
case StudyBibleType.refname:
case StudyBibleType.shortname:
studyBibleType = new StudyBibleType(e);
break;
case BibleTextOrganization.refname:
case BibleTextOrganization.shortname:
bibleTextOrganization = new BibleTextOrganization(e);
break;
case BibleReferenceLocation.refname:
case BibleReferenceLocation.shortname:
bibleReferenceLocation = new BibleReferenceLocation(e);
break;
case BiblePurpose.refname:
case BiblePurpose.shortname:
biblePurposes = JPU.addToList(biblePurposes, new BiblePurpose(e));
break;
case BibleTextFeature.refname:
case BibleTextFeature.shortname:
bibleTextFeatures = JPU.addToList(bibleTextFeatures, new BibleTextFeature(e));
break;
default:
break;
}
});
}
/**
* @return whether this tag (<Bible> or <bible>) is explicitly provided in the ONIX XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
@Override
public org.w3c.dom.Element getXmlElement() {
return element;
}
/////////////////////////////////////////////////////////////////////////////////
// MEMBERS
/////////////////////////////////////////////////////////////////////////////////
private ListOfOnixCodelist bibleContentss = ListOfOnixCodelist.emptyList();
/**
*
* An ONIX code indicating the content of an edition of the Bible or selected Biblical text, for example New
* Testament, Apocrypha, Pentateuch. Mandatory in each occurrence of the <Bible> composite, and repeatable so
* that a list such as Old Testament and Apocrypha can be expressed.
*
* Jonix-Comment: this list is required to contain at least one item
*/
public ListOfOnixCodelist bibleContentss() {
_initialize();
return bibleContentss;
}
private ListOfOnixCodelist bibleVersions = ListOfOnixCodelist.emptyList();
/**
*
* An ONIX code indicating the version of a Bible or selected Biblical text, for example King James, Jerusalem, New
* American Standard, Reina Valera. Mandatory in each occurrence of the <Bible> composite, and repeatable if a
* work includes text in two or more versions.
*
* Jonix-Comment: this list is required to contain at least one item
*/
public ListOfOnixCodelist bibleVersions() {
_initialize();
return bibleVersions;
}
private StudyBibleType studyBibleType = StudyBibleType.EMPTY;
/**
*
* An ONIX code identifying a particular study version of a Bible or selected Biblical text, for example Life
* Application. Optional and non-repeating. Some study Bibles are available in different editions based on different
* text versions.
*
* Jonix-Comment: this field is optional
*/
public StudyBibleType studyBibleType() {
_initialize();
return studyBibleType;
}
private BibleTextOrganization bibleTextOrganization = BibleTextOrganization.EMPTY;
/**
*
* An ONIX code indicating the way in which the content of a Bible or selected Biblical text is organized, for
* example Chronological, Chain reference. Optional and non-repeating.
*
* Jonix-Comment: this field is optional
*/
public BibleTextOrganization bibleTextOrganization() {
_initialize();
return bibleTextOrganization;
}
private BibleReferenceLocation bibleReferenceLocation = BibleReferenceLocation.EMPTY;
/**
*
* An ONIX code indicating where references are located as part of the content of a Bible or selected Biblical text,
* for example Center column. Optional and non-repeating.
*
* Jonix-Comment: this field is optional
*/
public BibleReferenceLocation bibleReferenceLocation() {
_initialize();
return bibleReferenceLocation;
}
private ListOfOnixCodelist biblePurposes = ListOfOnixCodelist.emptyList();
/**
*
* An ONIX code indicating the purpose for which a Bible or selected Biblical text is intended, for example Family,
* Lectern/pulpit. Optional and repeatable.
*
* Jonix-Comment: this list may be empty
*/
public ListOfOnixCodelist biblePurposes() {
_initialize();
return biblePurposes;
}
private ListOfOnixCodelist bibleTextFeatures = ListOfOnixCodelist.emptyList();
/**
*
* An ONIX code specifying a feature of a Bible text not covered elsewhere, eg red letter. Optional and
* repeatable.
*
* Jonix-Comment: this list may be empty
*/
public ListOfOnixCodelist bibleTextFeatures() {
_initialize();
return bibleTextFeatures;
}
@Override
public JonixBible asStruct() {
_initialize();
JonixBible struct = new JonixBible();
struct.bibleContentss = bibleContentss.values();
struct.biblePurposes = biblePurposes.values();
struct.bibleReferenceLocation = bibleReferenceLocation.value;
struct.bibleTextFeatures = bibleTextFeatures.values();
struct.bibleTextOrganization = bibleTextOrganization.value;
struct.bibleVersions = bibleVersions.values();
struct.studyBibleType = studyBibleType.value;
return struct;
}
}