Module jonix.onix3

Package com.tectonica.jonix.onix3

Class TextItemIdentifier

java.lang.Object

com.tectonica.jonix.onix3.TextItemIdentifier

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixTextItemIdentifier>, OnixComposite.OnixDataCompositeWithKey<JonixTextItemIdentifier,TextItemIdentifierTypes>, OnixTag, Serializable

public class TextItemIdentifier
extends Object
implements OnixComposite.OnixDataCompositeWithKey<JonixTextItemIdentifier,TextItemIdentifierTypes>, Serializable

Text item identifier composite

A repeatable group of data elements which together define an identifier of a text item in accordance with a specified scheme. The composite is optional.

Reference name	<TextItemIdentifier>
Short tag	<textitemidentifier>
Cardinality	0…n

This tag may be included in the following composites:

• <TextItem>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextItem ⯈ TextItemIdentifier

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: dt.DateOrDateTime)
static final TextItemIdentifier	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype

Constructor Summary

Constructors

Constructor	Description
TextItemIdentifier()
TextItemIdentifier(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixTextItemIdentifier	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 (ie a scheme which is not a standard and for which there is no individual ID type code).
IDValue	idValue()	An identifier of the type specified in <TextItemIDType>.
void	ifExists(Consumer<TextItemIdentifier> action)
TextItemIdentifierTypes	structKey()
TextItemIDType	textItemIDType()	An ONIX code identifying the scheme from which the identifier in <IDValue> is taken.

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

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

EMPTY

public static final TextItemIdentifier EMPTY

Constructor Details

TextItemIdentifier

public TextItemIdentifier()

TextItemIdentifier

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

ifExists

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

textItemIDType

public TextItemIDType textItemIDType()

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

Jonix-Comment: this field is required

idValue

public IDValue idValue()

An identifier of the type specified in <TextItemIDType>. Mandatory in each occurrence of the <TextItemIdentifier> composite, and non-repeating.

Jonix-Comment: this field is required

idTypeName

public IDTypeName idTypeName()

A name which identifies a proprietary identifier scheme (ie a scheme which is not a standard and for which there is no individual ID type code). Must be included when, and only when, the code in <TextItemIDType> indicates a proprietary scheme, eg a publisher’s own code. Optional and non-repeating

Jonix-Comment: this field is optional

asStruct

public JonixTextItemIdentifier asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixTextItemIdentifier>

structKey

public TextItemIdentifierTypes structKey()

Specified by:

structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixTextItemIdentifier,TextItemIdentifierTypes>