Module jonix.onix3

Package com.tectonica.jonix.onix3

Class TextSourceDescription

java.lang.Object

com.tectonica.jonix.onix3.TextSourceDescription

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Text source description

Brief text describing or providing context for the text author or corporate source, at the publisher’s discretion, and intended to be used in addition to <TextAuthor> or <TextSourceCorporate>. Optional, and repeatable to provide parallel descriptions in multiple languages. The language attribute is optional for a single instance of <TextSourceDescription>, but must be included in each instance if <TextSourceDescription> is repeated. The description may be used with either a person or corporate name, to draw attention to any aspect of the text source’s background which provides context for the text in <Text>.

Format	Variable length text, suggested maximum length 200 characters. XHTML is enabled in this element - see Using XHTML, HTML, XML, JSON within ONIX text fields
Reference name	<TextSourceDescription>
Short tag	<x557>
Cardinality	0…n
Attributes	language, textformat
Example	<TextSourceDescription textformat="05">Literary editor of <cite>The Spectator</cite></ContributorDescription>

This tag may be included in the following composites:

• <TextContent>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ TextSourceDescription
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ TextSourceDescription

Since:

Onix-3.07

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

textformat

public TextFormats textformat

value

public String value

This is the raw content of TextSourceDescription. 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 200 characters. XHTML is enabled in this element - see Using XHTML, HTML, XML, JSON within ONIX text fields

(type: XHTML)

EMPTY

public static final TextSourceDescription EMPTY

Constructor Details

TextSourceDescription

public TextSourceDescription()

TextSourceDescription

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

ifExists

public void ifExists(Consumer<TextSourceDescription> action)