Module jonix.onix3

Package com.tectonica.jonix.onix3

Class TitlePrefix

java.lang.Object

com.tectonica.jonix.onix3.TitlePrefix

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Title prefix

Text at the beginning of a title element which is to be ignored for alphabetical sorting. Optional and non-repeating; can only be used when <TitleText> is omitted, and if the <TitleWithoutPrefix> element is also present. These two elements may be used in combination in applications where it is necessary to distinguish an initial word or character string which is to be ignored for filing purposes, eg in library systems and in some bookshop databases.

Format	Variable length text, suggested maximum 20 characters
Reference name	<TitlePrefix>
Short tag	<b030>
Cardinality	0…1
Attributes	collationkey, language, textscript, textcase
Example	<TitlePrefix language="eng">The</TitlePrefix>

This tag may be included in the following composites:

• <TitleElement>

Possible placements within ONIX message:

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

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	collationkey	(type: dt.NonEmptyString)
String	datestamp	(type: dt.DateOrDateTime)
static final TitlePrefix	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 TitlePrefix.

Constructor Summary

Constructors

Constructor	Description
TitlePrefix()
TitlePrefix(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<TitlePrefix> 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 TitlePrefix. 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 20 characters

(type: dt.NonEmptyString)

EMPTY

public static final TitlePrefix EMPTY

Constructor Details

TitlePrefix

public TitlePrefix()

TitlePrefix

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

ifExists

public void ifExists(Consumer<TitlePrefix> action)