Module jonix.onix3

Package com.tectonica.jonix.onix3

Class YearOfAnnual

java.lang.Object

com.tectonica.jonix.onix3.YearOfAnnual

All Implemented Interfaces:

OnixElement<String>, OnixTag, Serializable

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

Year of annual

When the year of an annual is part of a title, this field should be used to carry the year (or, if required, a spread of years such as 2009–2010). Optional and non-repeating.

Format	Year or range of years, in the format YYYY or YYYY-YYYY
Reference name	<YearOfAnnual>
Short tag	<b020>
Cardinality	0…1
Example	<b020>2009</b020>

This tag may be included in the following composites:

• <TitleElement>

Possible placements within ONIX message:

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

See Also:

• Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

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

value

public String value

This is the raw content of YearOfAnnual. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Year or range of years, in the format YYYY or YYYY-YYYY

(type: dt.YearOrYearRange)

EMPTY

public static final YearOfAnnual EMPTY

Constructor Details

YearOfAnnual

public YearOfAnnual()

YearOfAnnual

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

ifExists

public void ifExists(Consumer<YearOfAnnual> action)