Module jonix.onix3

Package com.tectonica.jonix.onix3

Class RegionCode

java.lang.Object

com.tectonica.jonix.onix3.RegionCode

All Implemented Interfaces:

OnixElement<Regions>, OnixTag, Serializable

public class RegionCode
extends Object
implements OnixElement<Regions>, Serializable

Region code

An ONIX code identifying a region with which a contributor is particularly associated. Optional and non-repeatable. There must be an occurrence of either the <CountryCode> or the <RegionCode> elements in each occurrence of <ContributorPlace>. A region is an area which is not a country, but which is precisely defined in geographical terms, eg Northern Ireland, Australian Capital Territory. If both country and region are specified, the region must be within the country. Note that US States have region codes, while US overseas territories have distinct ISO Country Codes.

Format	Variable length code, consisting of upper case letters, with or without a hyphen and further upper case letters or digits. 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-2
Reference name	<RegionCode>
Short tag	<b398>
Cardinality	0…1
Example	<RegionCode>CA-NL</RegionCode> (Newfoundland and Labrador)

This tag may be included in the following composites:

• <ContributorPlace>
• <EventOccurrence>
• <Language>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ Contributor ⯈ ContributorPlace ⯈ RegionCode
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Contributor ⯈ ContributorPlace ⯈ RegionCode
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ Contributor ⯈ ContributorPlace ⯈ RegionCode
• Product ⯈ DescriptiveDetail ⯈ Collection ⯈ Contributor ⯈ ContributorPlace ⯈ RegionCode
• Product ⯈ PromotionDetail ⯈ PromotionalEvent ⯈ EventOccurrence ⯈ RegionCode
• Product ⯈ DescriptiveDetail ⯈ Language ⯈ RegionCode
• Product ⯈ ContentDetail ⯈ ContentItem ⯈ Language ⯈ RegionCode

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final RegionCode	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
Regions	value

Constructor Summary

Constructors

Constructor	Description
RegionCode()
RegionCode(Element element)

Method Summary

Modifier and Type	Method	Description
Regions	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
String	codeOrNull()
String	descriptionOrNull()
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

datestamp

public String datestamp

(type: dt.DateOrDateTime)

sourcename

public String sourcename

(type: dt.NonEmptyString)

sourcetype

public RecordSourceTypes sourcetype

value

public Regions value

EMPTY

public static final RegionCode EMPTY

Constructor Details

RegionCode

public RegionCode()

RegionCode

public RegionCode(Element element)

Method Details

__v

public Regions __v()

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

Specified by:

__v in interface OnixElement<Regions>

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)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()