Module jonix.onix2

Package com.tectonica.jonix.onix2

Class ProductClassification

java.lang.Object

com.tectonica.jonix.onix2.ProductClassification

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixProductClassification>, OnixComposite.OnixDataCompositeWithKey<JonixProductClassification,ProductClassificationTypes>, OnixTag, Serializable

public class ProductClassification
extends Object
implements OnixComposite.OnixDataCompositeWithKey<JonixProductClassification,ProductClassificationTypes>, Serializable

Product classification composite

A repeatable group of data elements which together define a product classification (NOT to be confused with a subject classification). The intended use is to enable national or international trade classifications (aka commodity codes) to be carried in an ONIX record.

Reference name	<ProductClassification>
Short tag	<productclassification>

This tag may be included in the following composites:

• <Product>

Possible placements within ONIX message:

• Product ⯈ ProductClassification

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 ProductClassification	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
ProductClassification()
ProductClassification(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixProductClassification	asStruct()
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<ProductClassification> action)
Percent	percent()	The percentage of the unit value of the product that is assignable to a designated product classification.
ProductClassificationCode	productClassificationCode()	A classification code from the scheme specified in <ProductClassificationType>.
ProductClassificationType	productClassificationType()	An ONIX code identifying the scheme from which the identifier in <ProductClassificationCode> is taken.
ProductClassificationTypes	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 ProductClassification EMPTY

Constructor Details

ProductClassification

public ProductClassification()

ProductClassification

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

ifExists

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

productClassificationType

public ProductClassificationType productClassificationType()

An ONIX code identifying the scheme from which the identifier in <ProductClassificationCode> is taken. Mandatory in any instance of the <ProductClassification> composite, and non-repeating.

Jonix-Comment: this field is required

productClassificationCode

public ProductClassificationCode productClassificationCode()

A classification code from the scheme specified in <ProductClassificationType>. Mandatory in any instance of the <ProductClassification> composite, and non-repeating.

Jonix-Comment: this field is required

percent

public Percent percent()

The percentage of the unit value of the product that is assignable to a designated product classification. Optional and non-repeating. Used when a mixed product (eg book and CD) belongs partly to two or more product classifications.

Jonix-Comment: this field is optional

asStruct

public JonixProductClassification asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixProductClassification>

structKey

public ProductClassificationTypes structKey()

Specified by:

structKey in interface OnixComposite.OnixDataCompositeWithKey<JonixProductClassification,ProductClassificationTypes>