Module jonix.onix2

Package com.tectonica.jonix.onix2

Class PageRun

java.lang.Object

com.tectonica.jonix.onix2.PageRun

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixPageRun>, OnixTag, Serializable

public class PageRun
extends Object
implements OnixComposite.OnixDataComposite<JonixPageRun>, Serializable

Page run composite

A repeatable group of data elements which together define a run of contiguous pages on which a text item appears. The composite is optional, but may be repeated where the text item covers two or more separate page runs.

Reference name	<PageRun>
Short tag	<pagerun>

This tag may be included in the following composites:

• <TextItem>

Possible placements within ONIX message:

• Product ⯈ ContentItem ⯈ TextItem ⯈ PageRun

Since:

Onix-2.1

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixComposite

OnixComposite.OnixDataComposite<V extends JonixStruct>, OnixComposite.OnixDataCompositeUncommon, OnixComposite.OnixDataCompositeWithKey<V extends JonixKeyedStruct<K>,K extends Enum<K> & OnixCodelist>, OnixComposite.OnixSuperComposite

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final PageRun	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration

Constructor Summary

Constructors

Constructor	Description
PageRun()
PageRun(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixPageRun	asStruct()
boolean	exists()	indicates whether this tag exists in the ONIX record
FirstPageNumber	firstPageNumber()	The number of the first page of a sequence of contiguous pages.
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<PageRun> action)
LastPageNumber	lastPageNumber()	The number of the last page of a sequence of contiguous pages (ignoring any blank verso which is left after the last text page).

Methods inherited from class java.lang.Object

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

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

EMPTY

public static final PageRun EMPTY

Constructor Details

PageRun

public PageRun()

PageRun

public PageRun(Element element)

Method Details

_initialize

public void _initialize()

Description copied from interface: OnixComposite

This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites

Specified by:

_initialize in interface OnixComposite

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 (<PageRun> or <pagerun>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<PageRun> action)

getXmlElement

public Element getXmlElement()

Description copied from interface: OnixComposite

For advanced use-cases only.

Specified by:

getXmlElement in interface OnixComposite

Returns:

native representation of the XML element underlying to this tag

firstPageNumber

public FirstPageNumber firstPageNumber()

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).

Jonix-Comment: this field is required

lastPageNumber

public LastPageNumber lastPageNumber()

The number of the last page of a sequence of contiguous pages (ignoring any blank verso which is left after the last text page). This element is omitted if an item begins and ends on the same page; otherwise it should occur once and only once in each occurrence of the <PageRun> composite.

Jonix-Comment: this field is optional

asStruct

public JonixPageRun asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixPageRun>