Module jonix.onix3

Package com.tectonica.jonix.onix3

Class LevelSequenceNumber

java.lang.Object

com.tectonica.jonix.onix3.LevelSequenceNumber

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Level sequence number

A number which specifies the position of a content item in a multi-level hierarchy of such items. Numbering starts at the top level in the hierarchy, which may represent (eg) chapters in a printed book, and the first item at the top level is numbered 1. Numbers should be assigned solely with a view to the logic of the ONIX description and not in relation to any other characteristics of the items being numbered (such as their actual numbering or their typographical layout in a printed table of contents). So for example, Chapter 2 could have a level sequence number of 3, and the second sub-section within Chapter 2 could be numbered 3.2. <LevelSequenceNumber> is not a required field, but it is strongly recommended for structured tables of contents. If used, it must occur once and only once in each occurrence of the <ContentItem> composite.

Format	Variable length string of positive integers, each successive integer being separated by a period character, suggested maximum length 100 characters
Reference name	<LevelSequenceNumber>
Short tag	<b284>
Cardinality	0…1
Example	<LevelSequenceNumber>2.24.1</LevelSequenceNumber>

This tag may be included in the following composites:

• <ContentItem>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ LevelSequenceNumber

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final LevelSequenceNumber	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
String	value	This is the raw content of LevelSequenceNumber.

Constructor Summary

Constructors

Constructor	Description
LevelSequenceNumber()
LevelSequenceNumber(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<LevelSequenceNumber> 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

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

value

public String value

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

Raw Format: Variable length string of positive integers, each successive integer being separated by a period character, suggested maximum length 100 characters

(type: dt.MultiLevelNumber)

EMPTY

public static final LevelSequenceNumber EMPTY

Constructor Details

LevelSequenceNumber

public LevelSequenceNumber()

LevelSequenceNumber

public LevelSequenceNumber(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 (<LevelSequenceNumber> or <b284>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<LevelSequenceNumber> action)