Module jonix.onix3

Package com.tectonica.jonix.onix3

Class SequenceNumber

java.lang.Object

com.tectonica.jonix.onix3.SequenceNumber

All Implemented Interfaces:

OnixElement<Integer>, OnixTag, Serializable

public class SequenceNumber
extends Object
implements OnixElement<Integer>, Serializable

Title element sequence number

A number which specifies a single overall sequence of title elements, which is the preferred order for display of the various title elements when constructing a complete title. Optional and non-repeating. It is strongly recommended that each occurrence of the <TitleElement> composite should carry a <SequenceNumber>.

Format	Positive integer, 1, 2, 3 etc, suggested maximum length 3 digits
Reference name	<SequenceNumber>
Short tag	<b034>
Cardinality	0…1
Example	<b034>2</b034>

Technical notes about <SequenceNumber> from the schema author: Ordinal number, eg of a contributor, indicating the required order (which may be different from the order of occurrence in the ONIX XML file itself) This tag may be included in the following composites:

• <SupportingResource>
• <SupplementManifest>
• <Prize>
• <CoverResource>
• <BodyResource>
• <TextContent>
• <TitleElement>
• <ContributorReference>
• <CitedContent>
• <InsertResource>
• <Contributor>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ SupportingResource ⯈ SequenceNumber
• Product ⯈ CollateralDetail ⯈ SupportingResource ⯈ SequenceNumber
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ SupportingResource ⯈ SequenceNumber
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ SupportingResource ⯈ SequenceNumber
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ SequenceNumber
• Product ⯈ CollateralDetail ⯈ Prize ⯈ SequenceNumber
• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ Prize ⯈ SequenceNumber
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ Prize ⯈ SequenceNumber
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ Prize ⯈ SequenceNumber
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ Prize ⯈ SequenceNumber
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ CoverManifest ⯈ CoverResource ⯈ SequenceNumber
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ CoverManifest ⯈ CoverResource ⯈ SequenceNumber
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ BodyManifest ⯈ BodyResource ⯈ SequenceNumber
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ BodyManifest ⯈ BodyResource ⯈ SequenceNumber
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ SequenceNumber
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ SequenceNumber
• Product ⯈ DescriptiveDetail ⯈ TitleDetail ⯈ TitleElement ⯈ SequenceNumber
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TitleDetail ⯈ TitleElement ⯈ SequenceNumber
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ TitleDetail ⯈ TitleElement ⯈ SequenceNumber
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ ContributorReference ⯈ SequenceNumber
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ CitedContent ⯈ SequenceNumber
• Product ⯈ CollateralDetail ⯈ CitedContent ⯈ SequenceNumber
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ SupplementManifest ⯈ InsertManifest ⯈ InsertResource ⯈ SequenceNumber
• Product ⯈ ProductionDetail ⯈ ProductionManifest ⯈ InsertManifest ⯈ InsertResource ⯈ SequenceNumber
• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ SequenceNumber
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ SequenceNumber
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ SequenceNumber
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ SequenceNumber

Since:

Onix-3.01

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
SequenceNumber()
SequenceNumber(Element element)

Method Summary

Modifier and Type	Method	Description
Integer	__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<SequenceNumber> 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 Integer value

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

Raw Format: Positive integer, 1, 2, 3 etc, suggested maximum length 3 digits

(type: dt.PositiveInteger)

EMPTY

public static final SequenceNumber EMPTY

Constructor Details

SequenceNumber

public SequenceNumber()

SequenceNumber

public SequenceNumber(Element element)

Method Details

__v

public Integer __v()

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

Specified by:

__v in interface OnixElement<Integer>

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

ifExists

public void ifExists(Consumer<SequenceNumber> action)