Module jonix.onix2

Package com.tectonica.jonix.onix2

Class TextFormat

java.lang.Object

com.tectonica.jonix.onix2.TextFormat

All Implemented Interfaces:

OnixElement<TextFormats>, OnixTag, Serializable

public class TextFormat
extends Object
implements OnixElement<TextFormats>, Serializable

Other text format

An ONIX code which identifies the format of text which is sent in the <Text> element, or referenced in the <TextLink> element. Optional and non-repeating. It is now possible to use a “textformat” attribute in the <Text> element for this purpose, and this is the recommended practise when the text is sent in the ONIX record. The <TextFormat> element may still be used when the text is held outside the ONIX record, and referenced by the <TextLink> element.

Format	Fixed-length, two numeric digits
Codelist	List 34
Reference name	<TextFormat>
Short tag	<d103>
Example	<d103>02</d103> HTML

This tag may be included in the following composites:

• <OtherText>

Possible placements within ONIX message:

• Product ⯈ OtherText ⯈ TextFormat
• Product ⯈ ContentItem ⯈ OtherText ⯈ TextFormat
• SubSeriesRecord ⯈ OtherText ⯈ TextFormat
• MainSeriesRecord ⯈ OtherText ⯈ TextFormat

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final TextFormat	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
TextFormats	value

Constructor Summary

Constructors

Constructor	Description
TextFormat()
TextFormat(Element element)

Method Summary

Modifier and Type	Method	Description
TextFormats	__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<TextFormat> 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

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

value

public TextFormats value

EMPTY

public static final TextFormat EMPTY

Constructor Details

TextFormat

public TextFormat()

TextFormat

public TextFormat(Element element)

Method Details

__v

public TextFormats __v()

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

Specified by:

__v in interface OnixElement<TextFormats>

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

ifExists

public void ifExists(Consumer<TextFormat> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()