Module jonix.onix3

Package com.tectonica.jonix.onix3

Class BiographicalNote

java.lang.Object

com.tectonica.jonix.onix3.BiographicalNote

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Biographical note

A biographical note about a contributor to the product. (See the <TextContent> composite in Group P.14 for a biographical note covering all contributors to a product in a single text.) Optional, and repeatable to provide parallel biographical notes in multiple languages. The language attribute is optional for a single instance of <BiographicalNote>, but must be included in each instance if <BiographicalNote> is repeated. May occur with a person name or with a corporate name. A biographical note in ONIX should always contain the name of the person or body concerned, and it should always be presented as a piece of continuous text consisting of full sentences. Some recipients of ONIX data feeds will not accept text which has embedded URLs. A contributor website link can be sent using the <Website> composite below.

Format	Variable length text, no suggested maximum length (since there is no suggested length for the text in a <TextContent> composite, where a biographical note can alternatively be sent). XHTML is enabled in this element - see Using XHTML, HTML, XML, JSON within ONIX text fields
Reference name	<BiographicalNote>
Short tag	<b044>
Cardinality	0…n
Attributes	language, textformat
Example	<b044 language="eng" textformat="05"><p><strong>Umberto Eco</strong>, professor of semiotics at the University of Bologna, and author of <cite>The Name Of The Rose</cite> and <cite>Foucault's Pendulum</cite>, is one of the world's bestselling novelists.</p><p>As well as novels, he also writes children's books and academic works.</p></b044> <b044 language="ita" textformat="05"><p><strong>Umberto Eco</strong>, professore di semiotica all'Università di Bologna e autore di <cite>Il nome della rosa</cite> e <cite>Il pendolo di Foucault</cite>, è uno dei romanzieri più venduto al mondo.</p><p>Così come romanzi, lui scrive anche libri per bambini e opere accademici.</p></b044> (text is marked up with XHTML, and both English and Italian versions are provided)
Example	<b044>Umberto Eco, professor of semiotics at the University of Bologna, and author of 'The Name Of The Rose' and 'Foucault's Pendulum', is one of the world's bestselling novelists. As well as novels, he also writes children's books and academic works.</b044> (text is not marked up)
Notes	Beware of biographical notes including phrases such as 'her latest work is…', as they are somewhat time-sensitive, and consider the use of the datestamp attribute if such phrases cannot be avoided.

This tag may be included in the following composites:

• <Contributor>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ BiographicalNote
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ BiographicalNote
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ BiographicalNote
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ BiographicalNote

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

Raw Format: Variable length text, no suggested maximum length (since there is no suggested length for the text in a <TextContent> composite, where a biographical note can alternatively be sent). XHTML is enabled in this element - see Using XHTML, HTML, XML, JSON within ONIX text fields

(type: XHTML)

EMPTY

public static final BiographicalNote EMPTY

Constructor Details

BiographicalNote

public BiographicalNote()

BiographicalNote

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

ifExists

public void ifExists(Consumer<BiographicalNote> action)