Module jonix.onix2

Package com.tectonica.jonix.onix2

Class FirstPageNumber

java.lang.Object

com.tectonica.jonix.onix2.FirstPageNumber

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

public class FirstPageNumber
extends Object
implements OnixElement<String>, Serializable

First page number

The number of the page on which a text item begins in a paginated product. Optional and non-repeating; required when the text item is being referenced as part of a structured table of contents.

Format	Variable-length alphanumeric, suggested maximum length 20 characters
Reference name	<FirstPageNumber>
Short tag	<b286>
Example	<b286>vii</b286>

This tag may be included in the following composites:

• <TextItem>
• <PageRun>

Possible placements within ONIX message:

• Product ⯈ ContentItem ⯈ TextItem ⯈ FirstPageNumber
• Product ⯈ ContentItem ⯈ TextItem ⯈ PageRun ⯈ FirstPageNumber

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final FirstPageNumber	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
String	value	This is the raw content of FirstPageNumber.

Constructor Summary

Constructors

Constructor	Description
FirstPageNumber()
FirstPageNumber(Element element)

Method Summary

Modifier and Type	Method	Description
String	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<FirstPageNumber> action)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tectonica.jonix.common.OnixElement

equal, is, isNull, value

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

value

public String value

This is the raw content of FirstPageNumber. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Variable-length alphanumeric, suggested maximum length 20 characters

(type: NonEmptyString)

EMPTY

public static final FirstPageNumber EMPTY

Constructor Details

FirstPageNumber

public FirstPageNumber()

FirstPageNumber

public FirstPageNumber(Element element)

Method Details

__v

public String __v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

Specified by:

__v in interface OnixElement<String>

exists

public boolean exists()

Description copied from interface: OnixTag

indicates whether this tag exists in the ONIX record

Specified by:

exists in interface OnixTag

Returns:

whether this tag (<FirstPageNumber> or <b286>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<FirstPageNumber> action)