com.tectonica.jonix.onix3.ExtentValue Maven / Gradle / Ivy
/*
* 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
*/
/**
* Extent value
*
* The numeric value of the extent specified in <ExtentType>. Optional, and non-repeating. However, either
* <ExtentValue> or <ExtentValueRoman>, or both, must be present in each occurrence of the <Extent>
* composite; and it is very strongly recommended that <ExtentValue> should always be included, even when
* the original product uses Roman numerals.
*
*
*
* Format
* Positive real number, with explicit decimal point when required, as appropriate for the units specified in
* <ExtentUnit>. Suggested maximum length 8 characters
*
*
* Reference name
* <ExtentValue>
*
*
* Short tag
* <b219>
*
*
* Cardinality
* 0…1
*
*
* Example
* <b219>2.5</b219>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link Extent}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link DescriptiveDetail} ⯈ {@link Extent} ⯈ {@link ExtentValue}
*
*/
public class ExtentValue implements OnixElement, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "ExtentValue";
public static final String shortname = "b219";
/////////////////////////////////////////////////////////////////////////////////
// ATTRIBUTES
/////////////////////////////////////////////////////////////////////////////////
/**
* (type: dt.DateOrDateTime)
*/
public String datestamp;
/**
* (type: dt.NonEmptyString)
*/
public String sourcename;
public RecordSourceTypes sourcetype;
/////////////////////////////////////////////////////////////////////////////////
// VALUE MEMBER
/////////////////////////////////////////////////////////////////////////////////
/**
* This is the raw content of ExtentValue. 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: Positive real number, with explicit decimal point when required, as appropriate for the units
* specified in <ExtentUnit>. Suggested maximum length 8 characters
*
* (type: dt.StrictPositiveDecimal)
*/
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 ExtentValue EMPTY = new ExtentValue();
public ExtentValue() {
exists = false;
}
public ExtentValue(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 (<ExtentValue> or <b219>) is explicitly provided in the ONIX XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
}