Module jonix.onix3

Package com.tectonica.jonix.onix3

Class CollectionSequenceNumber

java.lang.Object

com.tectonica.jonix.onix3.CollectionSequenceNumber

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Collection sequence number

A number which specifies the ordinal position of the product in a collection. The ordinal position may be a simple number (1st, 2nd, 3rd etc) or may be multi-level (eg 3.2) if the collection has a multi-level structure (ie there are both collection and sub-collection title elements). Mandatory and non-repeating within the <CollectionSequence> composite.

New from 3.0.4 A hyphen may be used in place of an integer within a multi-level number, where a particular level of the hierarchy is unnumbered, for example -.3 where a product is the third in a sub-collection, and the sub-collections are in no particular order within the collection.

Format	Variable length string of one or more positive integers or hyphens, each successive integer or hyphen being separated by a period character, suggested maximum length 50 characters
Reference name	<CollectionSequenceNumber>
Short tag	<x481>
Cardinality	1
Example	<CollectionSequenceNumber>2.4</CollectionSequenceNumber>

This tag may be included in the following composites:

• <CollectionSequence>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ CollectionSequence ⯈ CollectionSequenceNumber

Since:

Onix-3.01

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
CollectionSequenceNumber()
CollectionSequenceNumber(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<CollectionSequenceNumber> 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 CollectionSequenceNumber. 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 one or more positive integers or hyphens, each successive integer or hyphen being separated by a period character, suggested maximum length 50 characters

(type: dt.MultiLevelNumberOrHyphen)

EMPTY

public static final CollectionSequenceNumber EMPTY

Constructor Details

CollectionSequenceNumber

public CollectionSequenceNumber()

CollectionSequenceNumber

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

ifExists

public void ifExists(Consumer<CollectionSequenceNumber> action)