Module jonix.onix3

Package com.tectonica.jonix.onix3

Class MapScale

java.lang.Object

com.tectonica.jonix.onix3.MapScale

All Implemented Interfaces:

OnixElement<Integer>, OnixTag, Serializable

public class MapScale
extends Object
implements OnixElement<Integer>, Serializable

Map scale

The scale of a map, expressed as a ratio 1:nnnnn; only the number nnnnn is carried in the data element, without spaces or punctuation. Optional, and repeatable if a product comprises maps with two or more different scales.

Format	Positive integer, suggested maximum length 8 digits
Reference name	<MapScale>
Short tag	<b063>
Cardinality	0…n
Example	<b063>50000</b063> (One to 50,000, 2cm = 1km)

This tag may be included in the following composites:

• <DescriptiveDetail>

Possible placements within ONIX message:

• Product ⯈ DescriptiveDetail ⯈ MapScale

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: dt.DateOrDateTime)
static final MapScale	EMPTY
static final String	refname
static final String	shortname
String	sourcename	(type: dt.NonEmptyString)
RecordSourceTypes	sourcetype
Integer	value	This is the raw content of MapScale.

Constructor Summary

Constructors

Constructor	Description
MapScale()
MapScale(Element element)

Method Summary

Modifier and Type	Method	Description
Integer	__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<MapScale> 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 Integer value

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

Raw Format: Positive integer, suggested maximum length 8 digits

(type: dt.PositiveInteger)

EMPTY

public static final MapScale EMPTY

Constructor Details

MapScale

public MapScale()

MapScale

public MapScale(Element element)

Method Details

__v

public Integer __v()

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

Specified by:

__v in interface OnixElement<Integer>

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

ifExists

public void ifExists(Consumer<MapScale> action)