com.tectonica.jonix.onix3.ProductForm Maven / Gradle / Ivy

Go to download
/*
 * 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.onix3;

import com.tectonica.jonix.common.JPU;
import com.tectonica.jonix.common.OnixElement;
import com.tectonica.jonix.common.codelist.ProductForms;
import com.tectonica.jonix.common.codelist.RecordSourceTypes;

import java.io.Serializable;
import java.util.function.Consumer;

/*
 * NOTE: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT MANUALLY
 */

/**
 * Product form code
 * 
 * An ONIX code which indicates the primary form of a product. Mandatory in an occurrence of <DescriptiveDetail>,
 * and non-repeating. In ONIX 3.0, the handling of multiple-item products has been changed so that the form of the
 * contained items is now specified only in the <ProductPart> composite (equivalent to <Contained Item> in
 * ONIX 2.1, and now forming Group P.4), which must be included for full description of any
 * multiple-item product.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Format Fixed length, two letters (or the digits 00)
Codelist List 150
Reference name <ProductForm>
Short tag <b012>
Cardinality 1
Example <ProductForm>BB</ProductForm> (Hardback book)
 * 
 * This tag may be included in the following composites:
 * 

 * <{@link DescriptiveDetail}>
 * <{@link ProductPart}>
 * <{@link SupplementManifest}>
 * <{@link RelatedProduct}>
 * 
 * 
 * Possible placements within ONIX message:
 * 

 * {@link Product} ⯈ {@link DescriptiveDetail} ⯈ {@link ProductForm}
 * {@link Product} ⯈ {@link DescriptiveDetail} ⯈ {@link ProductPart} ⯈ {@link ProductForm}
 * {@link Product} ⯈ {@link ProductionDetail} ⯈ {@link ProductionManifest} ⯈ {@link SupplementManifest} ⯈
 * {@link ProductForm}
 * {@link Product} ⯈ {@link RelatedMaterial} ⯈ {@link RelatedProduct} ⯈ {@link ProductForm}
 * {@link Product} ⯈ {@link ContentDetail} ⯈ {@link ContentItem} ⯈ {@link RelatedProduct} ⯈ {@link ProductForm}
 * 
 */
public class ProductForm implements OnixElement, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "ProductForm";
    public static final String shortname = "b012";

    /////////////////////////////////////////////////////////////////////////////////
    // ATTRIBUTES
    /////////////////////////////////////////////////////////////////////////////////

    /**
     * (type: dt.DateOrDateTime)
     */
    public String datestamp;

    /**
     * (type: dt.NonEmptyString)
     */
    public String sourcename;

    public RecordSourceTypes sourcetype;

    /////////////////////////////////////////////////////////////////////////////////
    // VALUE MEMBER
    /////////////////////////////////////////////////////////////////////////////////

    public ProductForms value;

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

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

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

    public ProductForm() {
        exists = false;
    }

    public ProductForm(org.w3c.dom.Element element) {
        exists = true;
        datestamp = JPU.getAttribute(element, "datestamp");
        sourcename = JPU.getAttribute(element, "sourcename");
        sourcetype = RecordSourceTypes.byCode(JPU.getAttribute(element, "sourcetype"));

        value = ProductForms.byCode(JPU.getContentAsString(element));
    }

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

    public void ifExists(Consumer action) {
        if (exists) {
            action.accept(this);
        }
    }

    public String codeOrNull() {
        return value == null ? null : value.code;
    }

    public String descriptionOrNull() {
        return value == null ? null : value.description;
    }
}
Format	Fixed length, two letters (or the digits 00)
Codelist	List 150
Reference name	`<ProductForm>`
Short tag	`<b012>`
Cardinality	1
Example	`<ProductForm>BB</ProductForm>` (Hardback book)