com.tectonica.jonix.onix2.SetPartTitle 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.OnixElement;
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 java.io.Serializable;
import java.util.function.Consumer;
/*
* NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
*/
/**
* Set part (“subset”) title
*
* The title of a “subset” of which the product is a member, used only when a set is itself divided into two levels,
* eg A History of Western Europe, Part II: The Dark Ages, Volume I: After Rome. Use this field only for the
* section of the whole title which is shared by, and only by, the members of the subset. Optional and non-repeating.
* Note that this element is used for the first subdivision of a set which has two levels, regardless of the
* nomenclature (part, volume, etc) which the publisher uses at each level.
*
*
*
* Format
* Variable-length text, suggested maximum length 300 characters
*
*
* Reference name
* <SetPartTitle>
*
*
* Short tag
* <b025>
*
*
* Example
* <b025>The Dark Ages</b025>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link Set}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link Set} ⯈ {@link SetPartTitle}
*
*/
public class SetPartTitle implements OnixElement, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "SetPartTitle";
public static final String shortname = "b025";
/////////////////////////////////////////////////////////////////////////////////
// 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
/////////////////////////////////////////////////////////////////////////////////
/**
* This is the raw content of SetPartTitle. Could be null if {@code exists() == false}. Use {@link #value()} instead
* if you want to get this as an {@link java.util.Optional}.
*
* Raw Format: Variable-length text, suggested maximum length 300 characters
*
* (type: NonEmptyString)
*/
public String value;
/**
* Internal API, use the {@link #value()} method or the {@link #value} field instead
*/
@Override
public String __v() {
return value;
}
/////////////////////////////////////////////////////////////////////////////////
// SERVICES
/////////////////////////////////////////////////////////////////////////////////
private final boolean exists;
public static final SetPartTitle EMPTY = new SetPartTitle();
public SetPartTitle() {
exists = false;
}
public SetPartTitle(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 = JPU.getContentAsString(element);
}
/**
* @return whether this tag (<SetPartTitle> or <b025>) is explicitly provided in the ONIX XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
}