Module jonix.onix3

Package com.tectonica.jonix.onix3

Class TextSourceLink

java.lang.Object

com.tectonica.jonix.onix3.TextSourceLink

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Text source link

A URL which provides a link to a full text accessible in digital form, from which the supporting text in <Text> is an extract. Use, for example, to link to an original review. Optional, and repeatable if the resource can be linked in more than one way, eg by URL or DOI, or where a linked full text is available in multiple parallel languages. Where multiple languages are used, all repeats must carry the language attribute.

Format	Uniform Resource Locator, expressed in full URI syntax in accordance with W3C standards, suggested maximum length 300 characters. Note that non-ASCII characters, spaces and a handful of other special characters should be 'URL-encoded'. Any ampersand used to separate parameters in the URL must be expressed as &
Reference name	<TextSourceLink>
Short tag	<x581>
Cardinality	0…n
Attributes	language
Example	<x581>https://www.nytimes.com/archives/2012-08-04/Berni%e8res.htm</x581> (note URL-encoding of è)

This tag may be included in the following composites:

• <TextContent>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ TextContent ⯈ TextSourceLink
• Product ⯈ CollateralDetail ⯈ TextContent ⯈ TextSourceLink

Since:

Onix-3.10

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
TextSourceLink()
TextSourceLink(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<TextSourceLink> 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 TextSourceLink. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Uniform Resource Locator, expressed in full URI syntax in accordance with W3C standards, suggested maximum length 300 characters. Note that non-ASCII characters, spaces and a handful of other special characters should be 'URL-encoded'. Any ampersand used to separate parameters in the URL must be expressed as &amp;

(type: dt.NonEmptyURI)

EMPTY

public static final TextSourceLink EMPTY

Constructor Details

TextSourceLink

public TextSourceLink()

TextSourceLink

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

ifExists

public void ifExists(Consumer<TextSourceLink> action)