com.tectonica.jonix.onix2.BookFormDetail 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
There is a newer version: 2024-10-onix308
/*
 * 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.BookFormDetails;
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
 */

/**
 * Book form detail
 * 
 * An ONIX code specifying more detail of the product format when the product is a book. Repeatable when two or more
 * coded characteristics apply. This field is optional, but must only be included when the code in the
 * <ProductForm> element begins with letter B. This field will be superseded by the new element
 * <ProductFormDetail>, and the code list will not be further developed. The field is retained only for purposes
 * of upwards compatibility, and its use is now to be deprecated.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Format Fixed-length, two numeric digits
Codelist List 8
Reference name <BookFormDetail>
Short tag <b013>
Example <BookFormDetail>04</BookFormDetail> Paper over boards
 * 
 * This tag may be included in the following composites:
 * 

 * <{@link Product}>
 * <{@link ContainedItem}>
 * <{@link RelatedProduct}>
 * 
 * 
 * Possible placements within ONIX message:
 * 

 * {@link Product} ⯈ {@link BookFormDetail}
 * {@link Product} ⯈ {@link ContainedItem} ⯈ {@link BookFormDetail}
 * {@link Product} ⯈ {@link RelatedProduct} ⯈ {@link BookFormDetail}
 * 
 *
 * @deprecated
 */
@Deprecated
public class BookFormDetail implements OnixElement, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "BookFormDetail";
    public static final String shortname = "b013";

    /////////////////////////////////////////////////////////////////////////////////
    // 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 BookFormDetails value;

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

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

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

    public BookFormDetail() {
        exists = false;
    }

    public BookFormDetail(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 = BookFormDetails.byCode(JPU.getContentAsString(element));
    }

    /**
     * @return whether this tag (<BookFormDetail> or <b013>) is explicitly provided in the ONIX XML
     */
    @Override
    public boolean exists() {
        return exists;
    }

    public void ifExists(Consumer action) {
        if (exists) {
            action.accept(this);
        }
    }
}
Format	Fixed-length, two numeric digits
Codelist	List 8
Reference name	`<BookFormDetail>`
Short tag	`<b013>`
Example	`<BookFormDetail>04</BookFormDetail>` Paper over boards