Module jonix.onix3

Package com.tectonica.jonix.onix3

Class RelatedMaterial

java.lang.Object

com.tectonica.jonix.onix3.RelatedMaterial

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixSuperComposite, OnixTag, Serializable

public class RelatedMaterial
extends Object
implements OnixComposite.OnixSuperComposite, Serializable

Related material composite

The related material block covers data Groups P.22 and P.23, providing links to related works and related products. The block as a whole is optional and non-repeating.

None of the individual sections are mandatory within an occurrence of the block. However, in most circumstances, the block should contain at least one instance of <RelatedWork> or <RelatedProduct>. It may be empty only within a partial or ‘block update’ (Notification or update type 04, see P.1.2), when the intention is to remove all previously-supplied information about related works and products.

Reference name	<RelatedMaterial>
Short tag	<relatedmaterial>
Cardinality	0…1

This tag may be included in the following composites:

• <Product>

Possible placements within ONIX message:

• Product ⯈ RelatedMaterial

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

Constructor Summary

Constructors

Constructor	Description
RelatedMaterial()
RelatedMaterial(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<RelatedMaterial> action)
ListOfOnixComposite<RelatedProduct>	relatedProducts()	An optional group of data elements which together describe a product which has a specified relationship to the product described in the ONIX record.
ListOfOnixComposite<RelatedWork>	relatedWorks()	An optional group of data elements which together describe a work which has a specified relationship to the product described in the ONIX record.

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

Constructor Details

RelatedMaterial

public RelatedMaterial()

RelatedMaterial

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

ifExists

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

relatedWorks

public ListOfOnixComposite<RelatedWork> relatedWorks()

An optional group of data elements which together describe a work which has a specified relationship to the product described in the ONIX record. Repeatable in order to specify multiple works and their various relationships to the product.

Jonix-Comment: this list may be empty

relatedProducts

public ListOfOnixComposite<RelatedProduct> relatedProducts()

An optional group of data elements which together describe a product which has a specified relationship to the product described in the ONIX record. The composite is repeatable in order to specify different products which each have a relationship to the product described.

Jonix-Comment: this list may be empty