Module jonix.onix2

Package com.tectonica.jonix.onix2

Class Illustrations

java.lang.Object

com.tectonica.jonix.onix2.Illustrations

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixIllustrations>, OnixComposite.OnixDataCompositeWithKey<JonixIllustrations,IllustrationAndOtherContentTypes>, OnixTag, Serializable

public class Illustrations
extends Object
implements OnixComposite.OnixDataCompositeWithKey<JonixIllustrations,IllustrationAndOtherContentTypes>, Serializable

Illustrations and other content composite

A repeatable group of data elements which together specify the number of illustrations or other content items of a stated type which the product carries. Use of the <Illustrations> composite is optional.

Reference name	<Illustrations>
Short tag	<illustrations>

This tag may be included in the following composites:

• <Product>

Possible placements within ONIX message:

• Product ⯈ Illustrations

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: DateOrDateTime)
static final Illustrations	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration

Constructor Summary

Constructors

Constructor	Description
Illustrations()
Illustrations(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixIllustrations	asStruct()
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<Illustrations> action)
IllustrationType	illustrationType()	An ONIX code which identifies the type of illustration or other content to which an occurrence of the composite refers.
IllustrationTypeDescription	illustrationTypeDescription()	Text describing the type of illustration or other content to which an occurrence of the composite refers, when a code is insufficient.
Number	number()	The number of illustrations or other content items of the type specified in <IllustrationType>.
IllustrationAndOtherContentTypes	structKey()

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

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

EMPTY

public static final Illustrations EMPTY

Constructor Details

Illustrations

public Illustrations()

Illustrations

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

ifExists

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

illustrationType

public IllustrationType illustrationType()

An ONIX code which identifies the type of illustration or other content to which an occurrence of the composite refers. Mandatory in each occurrence of the <Illustrations> composite, and non-repeating.

Jonix-Comment: this field is required

illustrationTypeDescription

public IllustrationTypeDescription illustrationTypeDescription()

Text describing the type of illustration or other content to which an occurrence of the composite refers, when a code is insufficient. Optional and non-repeating. Required when <IllustrationType> carries the value 00.

Jonix-Comment: this field is optional

number

public Number number()

The number of illustrations or other content items of the type specified in <IllustrationType>. Optional and non-repeating.

Jonix-Comment: this field is optional

asStruct

public JonixIllustrations asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixIllustrations>

structKey

public IllustrationAndOtherContentTypes structKey()

Specified by:

structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixIllustrations,IllustrationAndOtherContentTypes>