com.tectonica.jonix.onix3.FirstPageNumber 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
*/
/**
* First page number
*
* The number of the first page of a sequence of contiguous pages. Mandatory in each occurrence of the <PageRun>
* composite, and non-repeating. Note that here and in the <LastPageNumber> element a page ‘number’ may be Arabic,
* Roman, or an alphanumeric string (eg L123).
*
*
*
* Format
* Variable length alphanumeric, suggested maximum length 20 characters
*
*
* Reference name
* <FirstPageNumber>
*
*
* Short tag
* <b286>
*
*
* Cardinality
* 1
*
*
* Example
* <FirstPageNumber>23</FirstPageNumber>
*
*
*
* This tag may be included in the following composites:
*
* - <{@link PageRun}>
*
*
* Possible placements within ONIX message:
*
* - {@link Product} ⯈ {@link ContentDetail} ⯈ {@link ContentItem} ⯈ {@link TextItem} ⯈ {@link PageRun} ⯈
* {@link FirstPageNumber}
*
*/
public class FirstPageNumber implements OnixElement, Serializable {
private static final long serialVersionUID = 1L;
public static final String refname = "FirstPageNumber";
public static final String shortname = "b286";
/////////////////////////////////////////////////////////////////////////////////
// ATTRIBUTES
/////////////////////////////////////////////////////////////////////////////////
/**
* (type: dt.DateOrDateTime)
*/
public String datestamp;
/**
* (type: dt.NonEmptyString)
*/
public String sourcename;
public RecordSourceTypes sourcetype;
/////////////////////////////////////////////////////////////////////////////////
// VALUE MEMBER
/////////////////////////////////////////////////////////////////////////////////
/**
* This is the raw content of FirstPageNumber. 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: Variable length alphanumeric, suggested maximum length 20 characters
*
* (type: dt.NonEmptyString)
*/
public String value;
/**
* Internal API, use the {@link #value()} method or the {@link #value} field instead
*/
@Override
public String __v() {
return value;
}
/////////////////////////////////////////////////////////////////////////////////
// SERVICES
/////////////////////////////////////////////////////////////////////////////////
private final boolean exists;
public static final FirstPageNumber EMPTY = new FirstPageNumber();
public FirstPageNumber() {
exists = false;
}
public FirstPageNumber(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.getContentAsString(element);
}
/**
* @return whether this tag (<FirstPageNumber> or <b286>) is explicitly provided in the ONIX XML
*/
@Override
public boolean exists() {
return exists;
}
public void ifExists(Consumer action) {
if (exists) {
action.accept(this);
}
}
}