com.tectonica.jonix.onix2.TitlePrefix 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
*/
/**
* Title prefix
*
* Text at the beginning of the distinctive title of the product which is to be ignored for alphabetical sorting.
* Optional and non-repeating; can only be used if the <TitleWithoutPrefix> element is also present. These two
* elements may be used in combination in applications where it is necessary to distinguish an initial word or character
* string which is to be ignored for filing purposes, eg in library systems and in some bookshop databases.
* The <Title> composite on a later page provides a more general method of handling all forms of title,
* and is to be preferred.
*
*
*
* Format
* Variable-length text, suggested maximum length 20 characters
*
*
* Reference name
* <TitlePrefix>
*
*
* Short tag
* <b030>
*
*
* Example
* <b030>The</b030>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link Product}>
* - <{@link Title}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link TitlePrefix}
* - {@link Product} ⯈ {@link Title} ⯈ {@link TitlePrefix}
* - {@link Product} ⯈ {@link ContentItem} ⯈ {@link Title} ⯈ {@link TitlePrefix}
* - {@link Product} ⯈ {@link Set} ⯈ {@link Title} ⯈ {@link TitlePrefix}
* - {@link SubSeriesRecord} ⯈ {@link Title} ⯈ {@link TitlePrefix}
* - {@link MainSeriesRecord} ⯈ {@link Title} ⯈ {@link TitlePrefix}
* - {@link Product} ⯈ {@link Series} ⯈ {@link Title} ⯈ {@link TitlePrefix}
*
*
* @deprecated
*/
@Deprecated
public class TitlePrefix implements OnixElement, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "TitlePrefix";
public static final String shortname = "b030";
/////////////////////////////////////////////////////////////////////////////////
// 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 TitlePrefix. 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 20 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 TitlePrefix EMPTY = new TitlePrefix();
public TitlePrefix() {
exists = false;
}
public TitlePrefix(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 (<TitlePrefix> or <b030>) is explicitly provided in the ONIX XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
}