com.tectonica.jonix.onix2.Subject Maven / Gradle / Ivy
Show all versions of jonix-onix2 Show documentation
/*
* 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.OnixComposite.OnixDataComposite;
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.JonixSubject;
import java.io.Serializable;
import java.util.Collections;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Additional subject composite
*
* An optional and repeatable group of data elements which together describe a subject classification or subject heading
* which is additional to the BISAC, BIC or other main subject category.
*
*
*
* Reference name
* <Subject>
*
*
* Short tag
* <subject>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link Product}>
* - <{@link ContentItem}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link Subject}
* - {@link Product} ⯈ {@link ContentItem} ⯈ {@link Subject}
*
*/
public class Subject implements OnixDataComposite, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "Subject";
public static final String shortname = "subject";
/////////////////////////////////////////////////////////////////////////////////
// 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 Subject EMPTY = new Subject();
public Subject() {
exists = false;
element = null;
initialized = true; // so that no further processing will be done on this intentionally-empty object
}
public Subject(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 SubjectSchemeIdentifier.refname:
case SubjectSchemeIdentifier.shortname:
subjectSchemeIdentifier = new SubjectSchemeIdentifier(e);
break;
case SubjectCode.refname:
case SubjectCode.shortname:
subjectCode = new SubjectCode(e);
break;
case SubjectSchemeName.refname:
case SubjectSchemeName.shortname:
subjectSchemeName = new SubjectSchemeName(e);
break;
case SubjectSchemeVersion.refname:
case SubjectSchemeVersion.shortname:
subjectSchemeVersion = new SubjectSchemeVersion(e);
break;
case SubjectHeadingText.refname:
case SubjectHeadingText.shortname:
subjectHeadingText = new SubjectHeadingText(e);
break;
default:
break;
}
});
}
/**
* @return whether this tag (<Subject> or <subject>) 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 SubjectSchemeIdentifier subjectSchemeIdentifier = SubjectSchemeIdentifier.EMPTY;
/**
*
* 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.
*
* Jonix-Comment: this field is required
*/
public SubjectSchemeIdentifier subjectSchemeIdentifier() {
_initialize();
return subjectSchemeIdentifier;
}
private SubjectCode subjectCode = SubjectCode.EMPTY;
/**
*
* A subject class or category code from the scheme specified in the <SubjectSchemeIdentifier> element. Either
* <SubjectCode> or <SubjectHeadingText> or both must be present in each occurrence of the
* <Subject> composite. Non-repeating.
*
* Jonix-Comment: this field is required
*/
public SubjectCode subjectCode() {
_initialize();
return subjectCode;
}
private SubjectSchemeName subjectSchemeName = SubjectSchemeName.EMPTY;
/**
*
* A name identifying a proprietary subject scheme when <SubjectSchemeIdentifier> is coded “24”. Optional and
* non-repeating.
*
* Jonix-Comment: this field is optional
*/
public SubjectSchemeName subjectSchemeName() {
_initialize();
return subjectSchemeName;
}
private SubjectSchemeVersion subjectSchemeVersion = SubjectSchemeVersion.EMPTY;
/**
*
* A number which identifies a version or edition of the subject scheme specified in the associated
* <SubjectSchemeIdentifier> element. Optional and non-repeating.
*
* Jonix-Comment: this field is optional
*/
public SubjectSchemeVersion subjectSchemeVersion() {
_initialize();
return subjectSchemeVersion;
}
private SubjectHeadingText subjectHeadingText = SubjectHeadingText.EMPTY;
/**
*
* The text of a subject heading taken from the scheme specified in the <SubjectSchemeIdentifier> element, or
* of free language keywords if the scheme is specified as “keywords”; or the text equivalent to the
* <SubjectCode> value, if both code and text are sent. Either <SubjectCode> or
* <SubjectHeadingText> or both must be present in each occurrence of the <Subject> composite.
* Non-repeating.
*
* Jonix-Comment: this field is optional
*/
public SubjectHeadingText subjectHeadingText() {
_initialize();
return subjectHeadingText;
}
@Override
public JonixSubject asStruct() {
_initialize();
JonixSubject struct = new JonixSubject();
struct.subjectCode = subjectCode.value;
struct.subjectHeadingTexts =
subjectHeadingText.exists() ? Collections.singletonList(subjectHeadingText.value) : Collections.emptyList();
struct.subjectSchemeIdentifier = subjectSchemeIdentifier.value;
struct.subjectSchemeName = subjectSchemeName.value;
struct.subjectSchemeVersion = subjectSchemeVersion.value;
return struct;
}
}