Module jonix.onix2

Package com.tectonica.jonix.onix2

Class SeriesIdentifier

java.lang.Object

com.tectonica.jonix.onix2.SeriesIdentifier

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixSeriesIdentifier>, OnixComposite.OnixDataCompositeWithKey<JonixSeriesIdentifier,CollectionIdentifierTypes>, OnixTag, Serializable

public class SeriesIdentifier
extends Object
implements OnixComposite.OnixDataCompositeWithKey<JonixSeriesIdentifier,CollectionIdentifierTypes>, Serializable

Series identifier composite

A repeatable group of data elements which together define an identifier of a series or subseries. The composite is optional, and may only repeat if two or more identifiers of different types are sent. It is not permissible to have two identifiers of the same type.

Reference name	<SeriesIdentifier>
Short tag	<seriesidentifier>

This tag may be included in the following composites:

• <SubSeriesRecord>
• <MainSeriesRecord>
• <Series>

Possible placements within ONIX message:

• SubSeriesRecord ⯈ SeriesIdentifier
• MainSeriesRecord ⯈ SeriesIdentifier
• Product ⯈ Series ⯈ SeriesIdentifier

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 SeriesIdentifier	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
SeriesIdentifier()
SeriesIdentifier(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixSeriesIdentifier	asStruct()
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
IDTypeName	idTypeName()	A name which identifies a proprietary identifier scheme when, and only when, the code in the <SeriesIDType> field indicates a proprietary scheme, eg a publisher’s own code.
IDValue	idValue()	An identifier of the type specified in the <SeriesIDType> field.
void	ifExists(Consumer<SeriesIdentifier> action)
SeriesIDType	seriesIDType()	An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken.
CollectionIdentifierTypes	structKey()

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 SeriesIdentifier EMPTY

Constructor Details

SeriesIdentifier

public SeriesIdentifier()

SeriesIdentifier

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

ifExists

public void ifExists(Consumer<SeriesIdentifier> 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

seriesIDType

public SeriesIDType seriesIDType()

An ONIX code identifying the scheme from which the identifier in the <IDValue> element is taken. Mandatory in each occurrence of the <SeriesIdentifier> composite, and non-repeating.

Jonix-Comment: this field is required

idValue

public IDValue idValue()

An identifier of the type specified in the <SeriesIDType> field. Mandatory in each occurrence of the <SeriesIdentifier> composite, and non-repeating.

Jonix-Comment: this field is required

idTypeName

public IDTypeName idTypeName()

A name which identifies a proprietary identifier scheme when, and only when, the code in the <SeriesIDType> field indicates a proprietary scheme, eg a publisher’s own code. Optional and non-repeating.

Jonix-Comment: this field is optional

asStruct

public JonixSeriesIdentifier asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixSeriesIdentifier>

structKey

public CollectionIdentifierTypes structKey()

Specified by:

structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixSeriesIdentifier,CollectionIdentifierTypes>