com.tectonica.jonix.onix2.LevelSequenceNumber Maven / Gradle / Ivy
Show all versions of jonix-onix2 Show documentation
/*
* 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.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
*/
/**
* Level sequence number
*
* A number which specifies the position of an item in a set within a multi-level hierarchy of such items. Numbering
* starts at the top level in the hierarchy, and the first item at the top level is numbered 1. Optional and
* non-repeating. The purpose of this element is to make it possible to describe structured sets in a normalized way,
* since enumeration carried as <ItemNumberWithinSet> may take a wide variety of forms.
*
*
*
* Format
* Variable-length string of integers, each successive integer being separated by a full stop, suggested maximum
* length 100 characters
*
*
* Reference name
* <LevelSequenceNumber>
*
*
* Short tag
* <b284>
*
*
* Example
* <b284>2.7</b284>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link ContentItem}>
* - <{@link Set}>
* - <{@link SubSeriesRecord}>
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link ContentItem} ⯈ {@link LevelSequenceNumber}
* - {@link Product} ⯈ {@link Set} ⯈ {@link LevelSequenceNumber}
* - {@link SubSeriesRecord} ⯈ {@link LevelSequenceNumber}
*
*
* @since Onix-2.1
*/
public class LevelSequenceNumber implements OnixElement, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "LevelSequenceNumber";
public static final String shortname = "b284";
/////////////////////////////////////////////////////////////////////////////////
// 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 LevelSequenceNumber. 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 string of integers, each successive integer being separated by a full stop, suggested
* maximum length 100 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 LevelSequenceNumber EMPTY = new LevelSequenceNumber();
public LevelSequenceNumber() {
exists = false;
}
public LevelSequenceNumber(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 (<LevelSequenceNumber> or <b284>) is explicitly provided in the ONIX XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
}