com.tectonica.jonix.onix2.ProductFormFeature 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
The newest version!
/*
 * 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.OnixComposite.OnixDataCompositeWithKey;
import com.tectonica.jonix.common.codelist.Languages;
import com.tectonica.jonix.common.codelist.ProductFormFeatureTypes;
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 com.tectonica.jonix.common.struct.JonixProductFormFeature;

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

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

/**
 * Product form feature composite
 * 
 * A repeatable group of data elements which together describe an aspect of product form that is too specific to be
 * covered in the <ProductForm> and <ProductFormDetail> elements. Optional.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Reference name <ProductFormFeature>
Short tag <productformfeature>
 * 
 * This tag may be included in the following composites:
 * 

 * <{@link Product}>
 * <{@link ContainedItem}>
 * <{@link RelatedProduct}>
 * 
 * Possible placements within ONIX message:
 * 
 * {@link Product} ⯈ {@link ProductFormFeature}
 * {@link Product} ⯈ {@link ContainedItem} ⯈ {@link ProductFormFeature}
 * {@link Product} ⯈ {@link RelatedProduct} ⯈ {@link ProductFormFeature}
 * 
 *
 * @since Onix-2.1
 */
public class ProductFormFeature
    implements OnixDataCompositeWithKey, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "ProductFormFeature";
    public static final String shortname = "productformfeature";

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

    public TextFormats textformat;

    public TextCaseFlags textcase;

    public Languages language;

    public TransliterationSchemes transliteration;

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

    public RecordSourceTypes sourcetype;

    public String sourcename;

    /////////////////////////////////////////////////////////////////////////////////
    // CONSTRUCTION
    /////////////////////////////////////////////////////////////////////////////////

    private boolean initialized;
    private final boolean exists;
    private final org.w3c.dom.Element element;
    public static final ProductFormFeature EMPTY = new ProductFormFeature();

    public ProductFormFeature() {
        exists = false;
        element = null;
        initialized = true; // so that no further processing will be done on this intentionally-empty object
    }

    public ProductFormFeature(org.w3c.dom.Element element) {
        exists = true;
        initialized = false;
        this.element = element;
        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");
    }

    @Override
    public void _initialize() {
        if (initialized) {
            return;
        }
        initialized = true;

        JPU.forElementsOf(element, e -> {
            final String name = e.getNodeName();
            switch (name) {
                case ProductFormFeatureType.refname:
                case ProductFormFeatureType.shortname:
                    productFormFeatureType = new ProductFormFeatureType(e);
                    break;
                case ProductFormFeatureValue.refname:
                case ProductFormFeatureValue.shortname:
                    productFormFeatureValue = new ProductFormFeatureValue(e);
                    break;
                case ProductFormFeatureDescription.refname:
                case ProductFormFeatureDescription.shortname:
                    productFormFeatureDescription = new ProductFormFeatureDescription(e);
                    break;
                default:
                    break;
            }
        });
    }

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

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

    @Override
    public org.w3c.dom.Element getXmlElement() {
        return element;
    }

    /////////////////////////////////////////////////////////////////////////////////
    // MEMBERS
    /////////////////////////////////////////////////////////////////////////////////

    private ProductFormFeatureType productFormFeatureType = ProductFormFeatureType.EMPTY;

    /**
     * 
     * An ONIX code which specifies the feature described by an instance of the <ProductFormFeature> composite,
     * eg binding color. Mandatory in each occurrence of the composite, and non-repeating.
     * 
     * JONIX adds: this field is required
     */
    public ProductFormFeatureType productFormFeatureType() {
        _initialize();
        return productFormFeatureType;
    }

    private ProductFormFeatureValue productFormFeatureValue = ProductFormFeatureValue.EMPTY;

    /**
     * 
     * A controlled value that describes a product form feature. Presence or absence of this element depends on the
     * <ProductFormFeatureType>, since some product form features (eg thumb index) do not require an
     * accompanying value, while others (eg text font) require free text in
     * <ProductFormFeatureDescription>. Non-repeating.
     * 
     * JONIX adds: this field is optional
     */
    public ProductFormFeatureValue productFormFeatureValue() {
        _initialize();
        return productFormFeatureValue;
    }

    private ProductFormFeatureDescription productFormFeatureDescription = ProductFormFeatureDescription.EMPTY;

    /**
     * 
     * If the <ProductFormFeatureType> requires free text rather than a code value, or if the code in
     * <ProductFormFeatureValue> does not adequately describe the feature, a short text description may be added.
     * Optional and non-repeating.
     * 
     * JONIX adds: this field is optional
     */
    public ProductFormFeatureDescription productFormFeatureDescription() {
        _initialize();
        return productFormFeatureDescription;
    }

    @Override
    public JonixProductFormFeature asStruct() {
        _initialize();
        JonixProductFormFeature struct = new JonixProductFormFeature();
        struct.productFormFeatureType = productFormFeatureType.value;
        struct.productFormFeatureDescriptions =
            productFormFeatureDescription.exists() ? Collections.singletonList(productFormFeatureDescription.value)
                : Collections.emptyList();
        struct.productFormFeatureValue = productFormFeatureValue.value;
        return struct;
    }

    @Override
    public ProductFormFeatureTypes structKey() {
        return productFormFeatureType().value;
    }
}
Reference name	`<ProductFormFeature>`
Short tag	`<productformfeature>`