Module jonix.onix3

Package com.tectonica.jonix.onix3

Class NameIDType

java.lang.Object

com.tectonica.jonix.onix3.NameIDType

All Implemented Interfaces:

OnixElement<NameIdentifierTypes>, OnixTag, Serializable

public class NameIDType
extends Object
implements OnixElement<NameIdentifierTypes>, Serializable

Name identifier type

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

Format	Fixed length, two digits
Codelist	List 44
Reference name	<NameIDType>
Short tag	<x415>
Cardinality	1
Example	<x415>01</x415> (Proprietary)

This tag may be included in the following composites:

• <NameIdentifier>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ AlternativeName ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ AlternativeName ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ AlternativeName ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ AlternativeName ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ DescriptiveDetail ⯈ NameAsSubject ⯈ AlternativeName ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ NameAsSubject ⯈ AlternativeName ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ ContributorReference ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ DescriptiveDetail ⯈ NameAsSubject ⯈ NameIdentifier ⯈ NameIDType
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ NameAsSubject ⯈ NameIdentifier ⯈ NameIDType

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final NameIDType	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
NameIdentifierTypes	value

Constructor Summary

Constructors

Constructor	Description
NameIDType()
NameIDType(Element element)

Method Summary

Modifier and Type	Method	Description
NameIdentifierTypes	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
String	codeOrNull()
String	descriptionOrNull()
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<NameIDType> 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 NameIdentifierTypes value

EMPTY

public static final NameIDType EMPTY

Constructor Details

NameIDType

public NameIDType()

NameIDType

public NameIDType(Element element)

Method Details

__v

public NameIdentifierTypes __v()

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

Specified by:

__v in interface OnixElement<NameIdentifierTypes>

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

ifExists

public void ifExists(Consumer<NameIDType> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()