com.tectonica.jonix.onix2.SubjectSchemeIdentifier 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
Collection of classes for processing Onix-2 sources
The newest version!
/*
 * 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.onix2;

import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.OnixElement;
import com.tectonica.jonix.common.codelist.Languages;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;
import com.tectonica.jonix.common.codelist.SubjectSchemeIdentifiers;
import com.tectonica.jonix.common.codelist.TextCaseFlags;
import com.tectonica.jonix.common.codelist.TextFormats;
import com.tectonica.jonix.common.codelist.TransliterationSchemes;

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

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

/**
 * Subject scheme identifier
 * 
 * An ONIX code which identifies the subject scheme which is used in an occurrence of the <Subject> composite.
 * Mandatory in each occurrence of the composite, and non-repeating.
 * 
 * 
 * When the scheme listed in the code list display is annotated “Code”, use the associated <SubjectCode> element
 * to carry the value (if so required, the <SubjectHeadingText> element can be used simultaneously to carry the
 * text equivalent of the code). When the scheme is annotated “Text”, use the <SubjectHeadingText> element to
 * carry the text of the subject heading.
 * 
 * 
 * Scheme code 23 may be used for a publisher’s own subject category code, by agreement with trading partners to whom
 * product information is sent. Scheme code 24, with a name in the <SubjectSchemeName> element, may be used to
 * identify a proprietary scheme, eg one used by a bibliographic agency or wholesaler.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Format Fixed-length, two numeric digits.
Codelist List 27
Reference name <SubjectSchemeIdentifier>
Short tag <b067>
Example <b067>03</b067> LC classification
 * 
 * This tag may be included in the following composites:
 * 

 * <{@link Subject}>
 * 
 * Possible placements within ONIX message:
 * 
 * {@link Product} ⯈ {@link Subject} ⯈ {@link SubjectSchemeIdentifier}
 * {@link Product} ⯈ {@link ContentItem} ⯈ {@link Subject} ⯈ {@link SubjectSchemeIdentifier}
 * 
 */
public class SubjectSchemeIdentifier implements OnixElement, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "SubjectSchemeIdentifier";
    public static final String shortname = "b067";

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

    public TextFormats textformat;

    public TextCaseFlags textcase;

    public Languages language;

    public TransliterationSchemes transliteration;

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

    public RecordSourceTypes sourcetype;

    public String sourcename;

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

    public SubjectSchemeIdentifiers value;

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

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

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

    public SubjectSchemeIdentifier() {
        exists = false;
    }

    public SubjectSchemeIdentifier(org.w3c.dom.Element element) {
        exists = true;
        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");

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

    /**
     * @return whether this tag (<SubjectSchemeIdentifier> or <b067>) 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 numeric digits.
Codelist	List 27
Reference name	`<SubjectSchemeIdentifier>`
Short tag	`<b067>`
Example	`<b067>03</b067>` LC classification