Module jonix.onix3

Package com.tectonica.jonix.onix3

Class Funding

java.lang.Object

com.tectonica.jonix.onix3.Funding

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable

public class Funding
extends Object
implements OnixComposite.OnixSuperComposite, Serializable

Funding composite

An optional group of data elements which together identify a grant or award provided by the entity specified as a funder in an occurrence of the <Publisher> composite, to subsidize research or publication. Repeatable when the funder provides multiple grants or awards. Used only when <PublishingRole> indicates the role of a funder.

Reference name	<Funding>
Short tag	<funding>
Cardinality	0…n

This tag may be included in the following composites:

• <Publisher>

Possible placements within ONIX message:

• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Publisher ⯈ Funding
• Product ⯈ PublishingDetail ⯈ Publisher ⯈ Funding

Since:

Onix-3.03

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.tectonica.jonix.common.OnixComposite

OnixComposite.OnixDataComposite<V extends JonixStruct>, OnixComposite.OnixDataCompositeUncommon, OnixComposite.OnixDataCompositeWithKey<V extends JonixKeyedStruct<K>,K extends Enum<K> & OnixCodelist>, OnixComposite.OnixSuperComposite

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final Funding	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype

Constructor Summary

Constructors

Constructor	Description
Funding()
Funding(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
boolean	exists()	indicates whether this tag exists in the ONIX record
ListOfOnixDataCompositeWithKey<FundingIdentifier,JonixFundingIdentifier,GrantIdentifierTypes>	fundingIdentifiers()	A group of data elements which together identify a particular grant or award.
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<Funding> action)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

EMPTY

public static final Funding EMPTY

Constructor Details

Funding

public Funding()

Funding

public Funding(Element element)

Method Details

_initialize

public void _initialize()

Description copied from interface: OnixComposite

This is an internal API. Since Jonix 8.0, composite objects are being populated lazily. This method initiates the population process, and is invoked internally by the accessor APIs of the composites

Specified by:

_initialize in interface OnixComposite

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

ifExists

public void ifExists(Consumer<Funding> action)

getXmlElement

public Element getXmlElement()

Description copied from interface: OnixComposite

For advanced use-cases only.

Specified by:

getXmlElement in interface OnixComposite

Returns:

native representation of the XML element underlying to this tag

fundingIdentifiers

public ListOfOnixDataCompositeWithKey<FundingIdentifier,JonixFundingIdentifier,GrantIdentifierTypes> fundingIdentifiers()

A group of data elements which together identify a particular grant or award. At least one <FundingIdentifier> composite must occur in each instance of the <Funding> composite. Repeatable when the grant or award has multiple identifiers.

Jonix-Comment: this list is required to contain at least one item