Module jonix.onix3

Package com.tectonica.jonix.onix3

Class ComponentTypeName

java.lang.Object

com.tectonica.jonix.onix3.ComponentTypeName

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Component type name

The generic name (if any) which is given in the product to the type of section which the content item represents, eg Chapter, Part, Track. Optional and non-repeating; but either this field or a title (in the <TitleDetail> composite), or both, must be present in each occurrence of the <ContentItem>.

Format	Variable length alphanumeric, suggested maximum length 20 characters
Reference name	<ComponentTypeName>
Short tag	<b288>
Cardinality	0…1
Attributes	language
Example	<b288>Chapter</b288>

This tag may be included in the following composites:

• <ContentItem>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ ComponentTypeName

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

language

public Languages language

value

public String value

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

Raw Format: Variable length alphanumeric, suggested maximum length 20 characters

(type: dt.NonEmptyString)

EMPTY

public static final ComponentTypeName EMPTY

Constructor Details

ComponentTypeName

public ComponentTypeName()

ComponentTypeName

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

ifExists

public void ifExists(Consumer<ComponentTypeName> action)