Module jonix.onix3

Package com.tectonica.jonix.onix3

Class RelatedWork

java.lang.Object

com.tectonica.jonix.onix3.RelatedWork

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable

public class RelatedWork
extends Object
implements OnixComposite.OnixSuperComposite, Serializable

Related work composite (content item)

A group of data elements which together describe a work which has a specified relationship to a content item. Optional and repeatable.

Reference name	<RelatedWork>
Short tag	<relatedwork>
Cardinality	0…n

This tag may be included in the following composites:

• <RelatedMaterial>
• <ContentItem>

Possible placements within ONIX message:

• Product ⯈ RelatedMaterial ⯈ RelatedWork
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ RelatedWork

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 RelatedWork	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype

Constructor Summary

Constructors

Constructor	Description
RelatedWork()
RelatedWork(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
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<RelatedWork> action)
ListOfOnixDataCompositeWithKey<WorkIdentifier,JonixWorkIdentifier,WorkIdentifierTypes>	workIdentifiers()	A group of data elements which together define an identifier of a work in accordance with a specified scheme.
WorkRelationCode	workRelationCode()	An ONIX code which identifies the nature of the relationship between a product and a work.

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 RelatedWork EMPTY

Constructor Details

RelatedWork

public RelatedWork()

RelatedWork

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

ifExists

public void ifExists(Consumer<RelatedWork> 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

workRelationCode

public WorkRelationCode workRelationCode()

An ONIX code which identifies the nature of the relationship between a product and a work. Mandatory in each occurrence of the <RelatedWork> composite, and non-repeating.

Jonix-Comment: this field is required

workIdentifiers

public ListOfOnixDataCompositeWithKey<WorkIdentifier,JonixWorkIdentifier,WorkIdentifierTypes> workIdentifiers()

A group of data elements which together define an identifier of a work in accordance with a specified scheme. Mandatory in each occurrence of the <RelatedWork> composite, and repeatable if two or more identifiers for the same work are sent using different identifier schemes (eg proprietary ID and DOI).

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