com.tectonica.jonix.onix3.BiblePurpose Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2012-2024 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.onix3;

import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.OnixElement;
import com.tectonica.jonix.common.codelist.BiblePurposes;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;

import java.io.Serializable;
import java.util.function.Consumer;

/*
 * NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
 */

/**
 * Bible purpose
 * 
 * An ONIX code indicating the purpose for which a Bible or selected Biblical text is intended, for example ‘Family’,
 * ‘Lectern/pulpit’. Optional, and repeatable to list multiple purposes.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Format Fixed length, two letters
Codelist List 85
Reference name <BiblePurpose>
Short tag <b354>
Cardinality 0…n
Example <BiblePurpose>LP</BiblePurpose> (Lectern/pulpit)
 * 
 * This tag may be included in the following composites:
 * 

 * <{@link Bible}>
 * 
 * 
 * Possible placements within ONIX message:
 * 

 * {@link Product} ⯈ {@link DescriptiveDetail} ⯈ {@link ReligiousText} ⯈ {@link Bible} ⯈ {@link BiblePurpose}
 * 
 */
public class BiblePurpose implements OnixElement, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "BiblePurpose";
    public static final String shortname = "b354";

    /////////////////////////////////////////////////////////////////////////////////
    // ATTRIBUTES
    /////////////////////////////////////////////////////////////////////////////////

    /**
     * (type: dt.DateOrDateTime)
     */
    public String datestamp;

    /**
     * (type: dt.NonEmptyString)
     */
    public String sourcename;

    public RecordSourceTypes sourcetype;

    /////////////////////////////////////////////////////////////////////////////////
    // VALUE MEMBER
    /////////////////////////////////////////////////////////////////////////////////

    public BiblePurposes value;

    /**
     * Internal API, use the {@link #value()} method or the {@link #value} field instead
     */
    @Override
    public BiblePurposes __v() {
        return value;
    }

    /////////////////////////////////////////////////////////////////////////////////
    // SERVICES
    /////////////////////////////////////////////////////////////////////////////////

    private final boolean exists;
    public static final BiblePurpose EMPTY = new BiblePurpose();

    public BiblePurpose() {
        exists = false;
    }

    public BiblePurpose(org.w3c.dom.Element element) {
        exists = true;
        datestamp = JPU.getAttribute(element, "datestamp");
        sourcename = JPU.getAttribute(element, "sourcename");
        sourcetype = RecordSourceTypes.byCode(JPU.getAttribute(element, "sourcetype"));

        value = BiblePurposes.byCode(JPU.getContentAsString(element));
    }

    /**
     * @return whether this tag (<BiblePurpose> or <b354>) is explicitly provided in the ONIX XML
     */
    @Override
    public boolean exists() {
        return exists;
    }

    public void ifExists(Consumer action) {
        if (exists) {
            action.accept(this);
        }
    }

    public String codeOrNull() {
        return value == null ? null : value.code;
    }

    public String descriptionOrNull() {
        return value == null ? null : value.description;
    }
}
Format	Fixed length, two letters
Codelist	List 85
Reference name	`<BiblePurpose>`
Short tag	`<b354>`
Cardinality	0…n
Example	`<BiblePurpose>LP</BiblePurpose>` (Lectern/pulpit)