Module jonix.onix3

Package com.tectonica.jonix.onix3

Class Subtitle

java.lang.Object

com.tectonica.jonix.onix3.Subtitle

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Subtitle

The text of a subtitle, if any. ‘Subtitle‘ means any added words which appear with the title element given in an occurrence of the <TitleElement> composite, and which amplify and explain the title element, but which are not considered to be part of the title element itself. Optional and non-repeating.

Format	Variable length text, suggested maximum 300 characters
Reference name	<Subtitle>
Short tag	<b029>
Cardinality	0…1
Attributes	collationkey, language, textscript, textcase
Example	<Subtitle textcase="02">The Russian Revolution 1891-1924</Subtitle>

This tag may be included in the following composites:

• <TitleElement>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ TitleDetail ⯈ TitleElement ⯈ Subtitle
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TitleDetail ⯈ TitleElement ⯈ Subtitle
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ TitleDetail ⯈ TitleElement ⯈ Subtitle

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

language

public Languages language

textscript

public TextScripts textscript

textcase

public TextCaseFlags textcase

value

public String value

This is the raw content of Subtitle. 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 300 characters

(type: dt.NonEmptyString)

EMPTY

public static final Subtitle EMPTY

Constructor Details

Subtitle

public Subtitle()

Subtitle

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

ifExists

public void ifExists(Consumer<Subtitle> action)