Module jonix.onix3

Package com.tectonica.jonix.onix3

Class Barcode

java.lang.Object

com.tectonica.jonix.onix3.Barcode

All Implemented Interfaces:

OnixComposite, OnixComposite.OnixDataComposite<JonixBarcode>, OnixTag, Serializable

public class Barcode
extends Object
implements OnixComposite.OnixDataComposite<JonixBarcode>, Serializable

Barcode composite

A group of data elements which together specify a barcode type and its position on a product. Optional: expected to be used only in North America. Repeatable if more than one type of barcode is carried on a single product. The absence of this composite does not mean that a product is not bar-coded.

Reference name	<Barcode>
Short tag	<barcode>
Cardinality	0…n

This tag may be included in the following composites:

• <Product>

Possible placements within ONIX message:

• Product ⯈ Barcode

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

Constructor Summary

Constructors

Constructor	Description
Barcode()
Barcode(Element element)

Method Summary

Modifier and Type	Method	Description
void	_initialize()	This is an internal API.
JonixBarcode	asStruct()
BarcodeType	barcodeType()	An ONIX code indicating whether, and in what form, a barcode is carried on a product.
boolean	exists()	indicates whether this tag exists in the ONIX record
Element	getXmlElement()	For advanced use-cases only.
void	ifExists(Consumer<Barcode> action)
PositionOnProduct	positionOnProduct()	An ONIX code indicating a position on a product; in this case, the position in which a barcode appears.

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

Constructor Details

Barcode

public Barcode()

Barcode

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

ifExists

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

barcodeType

public BarcodeType barcodeType()

An ONIX code indicating whether, and in what form, a barcode is carried on a product. Mandatory in any instance of the <Barcode> composite, and non-repeating.

Jonix-Comment: this field is required

positionOnProduct

public PositionOnProduct positionOnProduct()

An ONIX code indicating a position on a product; in this case, the position in which a barcode appears. Required if the <BarcodeType> element indicates that the barcode appears on the product, even if the position is ‘unknown’. Omitted if the <BarcodeType> element specifies that the product does not carry a barcode. Non-repeating.

Jonix-Comment: this field is optional

asStruct

public JonixBarcode asStruct()

Specified by:

asStruct in interface OnixComposite.OnixDataComposite<JonixBarcode>