Module jonix.onix3

Package com.tectonica.jonix.onix3

Class KeyNames

java.lang.Object

com.tectonica.jonix.onix3.KeyNames

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Person name part 4: key name(s)

The fourth part of a structured name of a person who contributed to the creation of the product: key name(s), ie the name elements normally used to open an entry in an alphabetical list, eg ‘Smith’ or ‘Garcia Marquez’ or ‘Madonna’ or ‘Francis de Sales’ (in Saint Francis de Sales). Non-repeating. Required if name part elements P.7.11 to P.7.18 are used.

Format	Variable length text, suggested maximum length 100 characters
Reference name	<KeyNames>
Short tag	<b040>
Cardinality	0…1
Attributes	collationkey, language, textscript
Example	<b040>Beethoven</b040>

This tag may be included in the following composites:

• <AlternativeName>
• <Contributor>
• <NameAsSubject>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ AlternativeName ⯈ KeyNames
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ AlternativeName ⯈ KeyNames
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ AlternativeName ⯈ KeyNames
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ AlternativeName ⯈ KeyNames
• Product ⯈ DescriptiveDetail ⯈ NameAsSubject ⯈ AlternativeName ⯈ KeyNames
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ NameAsSubject ⯈ AlternativeName ⯈ KeyNames
• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ KeyNames
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ KeyNames
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ KeyNames
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ KeyNames
• Product ⯈ DescriptiveDetail ⯈ NameAsSubject ⯈ KeyNames
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ NameAsSubject ⯈ KeyNames

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
KeyNames()
KeyNames(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<KeyNames> 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

collationkey

public String collationkey

(type: dt.NonEmptyString)

textscript

public TextScripts textscript

language

public Languages language

value

public String value

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

Raw Format: Variable length text, suggested maximum length 100 characters

(type: dt.NonEmptyString)

EMPTY

public static final KeyNames EMPTY

Constructor Details

KeyNames

public KeyNames()

KeyNames

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

ifExists

public void ifExists(Consumer<KeyNames> action)