Module jonix.onix2

Package com.tectonica.jonix.onix2

Class RegionCode

java.lang.Object

com.tectonica.jonix.onix2.RegionCode

All Implemented Interfaces:

OnixElement<Set<String>>, OnixTag, Serializable

public class RegionCode
extends Object
implements OnixElement<Set<String>>, Serializable

Region code

An ONIX code identifying a region with which a contributor is particularly associated, when this is significant for the marketing of a product. Optional and repeatable.

Format	Variable-length code, consisting of upper case letters with or without a hyphen, successive codes being separated by spaces. Suggested maximum length 8 characters.
Codelist	List 49 Where possible and appropriate, country subdivision codes are derived from the UN LOCODE scheme based on ISO 3166.
Reference name	<RegionCode>
Short tag	<b398>
Example	<b398>CA-BC</b398> British Columbia

This tag may be included in the following composites:

• <Contributor>

Possible placements within ONIX message:

• Product ⯈ Contributor ⯈ RegionCode
• Product ⯈ ContentItem ⯈ Contributor ⯈ RegionCode
• SubSeriesRecord ⯈ Contributor ⯈ RegionCode
• MainSeriesRecord ⯈ Contributor ⯈ RegionCode
• Product ⯈ Series ⯈ Contributor ⯈ RegionCode

Since:

Onix-2.12

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final RegionCode	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
Set<String>	value	This is the raw content of RegionCode.

Constructor Summary

Constructors

Constructor	Description
RegionCode()
RegionCode(Element element)

Method Summary

Modifier and Type	Method	Description
Set<String>	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<RegionCode> action)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.tectonica.jonix.common.OnixElement

equal, is, isNull, value

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

value

public Set<String> value

This is the raw content of RegionCode. Could be null if exists() == false. Use OnixElement.value() instead if you want to get this as an Optional.

Raw Format: Variable-length code, consisting of upper case letters with or without a hyphen, successive codes being separated by spaces. Suggested maximum length 8 characters.

(type: NonEmptyString)

EMPTY

public static final RegionCode EMPTY

Constructor Details

RegionCode

public RegionCode()

RegionCode

public RegionCode(Element element)

Method Details

__v

public Set<String> __v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

Specified by:

__v in interface OnixElement<Set<String>>

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 (<RegionCode> or <b398>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<RegionCode> action)