com.tectonica.jonix.onix3.Percent 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.RecordSourceTypes;

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

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

/**
 * Percentage
 * 
 * The percentage of the unit value of the product that is assignable to a designated product classification. Optional
 * and non-repeating. Used when a mixed product (eg book and CD) belongs partly to two or more product classes
 * within a particular scheme. If omitted, the product classification code applies to 100% of the product.
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * Format Real number between zero and 100 (inclusive), with explicit decimal point when required, suggested maximum length
 * 7 characters
Reference name <Percent>
Short tag <b337>
Cardinality 0…1
Example <Percent>66.67</Percent>
 * 
 * This tag may be included in the following composites:
 * 

 * <{@link ProductClassification}>
 * 
 * 
 * Possible placements within ONIX message:
 * 

 * {@link Product} ⯈ {@link DescriptiveDetail} ⯈ {@link ProductClassification} ⯈ {@link Percent}
 * 
 */
public class Percent implements OnixElement, Serializable {
    private static final long serialVersionUID = 1L;

    public static final String refname = "Percent";
    public static final String shortname = "b337";

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

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

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

    public RecordSourceTypes sourcetype;

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

    /**
     * This is the raw content of Percent. 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: Real number between zero and 100 (inclusive), with explicit decimal point when required, suggested
     * maximum length 7 characters
     * 
     * (type: dt.PercentDecimal)
     */
    public Double value;

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

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

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

    public Percent() {
        exists = false;
    }

    public Percent(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 = JPU.getContentAsDouble(element);
    }

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

    public void ifExists(Consumer action) {
        if (exists) {
            action.accept(this);
        }
    }
}
Format	Real number between zero and 100 (inclusive), with explicit decimal point when required, suggested maximum length * 7 characters
Reference name	`<Percent>`
Short tag	`<b337>`
Cardinality	0…1
Example	`<Percent>66.67</Percent>`