Module org.opengis.geoapi

Package org.opengis.referencing.cs

Class CoordinateDataType

Object

CodeList<CoordinateDataType>

CoordinateDataType

All Implemented Interfaces:

Serializable, Comparable<CoordinateDataType>, ControlledVocabulary

@UML(identifier="CoordinateDataType",
     specification=ISO_19111)
public final class CoordinateDataType
extends CodeList<CoordinateDataType>

Type (measure, integer or date) of coordinate values. Most axes implicitly use the MEASURE type.

Since:

3.1

See Also:

• TimeCS.getCoordinateType()
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opengis.util.CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final CoordinateDataType	DATE_TIME	Numbers related to dates or times expressed in the proleptic Gregorian calendar.
static final CoordinateDataType	INTEGER	Quantity expressed as a count used for a temporal or ordinal coordinate system axis.
static final CoordinateDataType	MEASURE	Quantity expressed as a measure used for a temporal coordinate system axis.

Method Summary

Modifier and Type	Method	Description
CoordinateDataType[]	family()	Returns the list of codes of the same kind as this code list element.
static CoordinateDataType	valueOf(String code)	Returns the coordinate data type that matches the given string, or returns a new one if none match it.
static CoordinateDataType[]	values()	Returns the list of CoordinateDataTypes.

Methods inherited from class org.opengis.util.CodeList

compareTo, identifier, name, ordinal, readResolve, toString, valueOf, valueOf, valueOf, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengis.util.ControlledVocabulary

names

Field Details

INTEGER

@UML(identifier="integer",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final CoordinateDataType INTEGER

Quantity expressed as a count used for a temporal or ordinal coordinate system axis. The fractional values between integer values may have no meaning.

MEASURE

@UML(identifier="measure",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final CoordinateDataType MEASURE

Quantity expressed as a measure used for a temporal coordinate system axis. This is the usual type for coordinate system axes.

DATE_TIME

@UML(identifier="dateTime",
     obligation=CONDITIONAL,
     specification=ISO_19111)
public static final CoordinateDataType DATE_TIME

Numbers related to dates or times expressed in the proleptic Gregorian calendar. This is used for a temporal coordinate system axis. The time elapsed between two consecutive coordinate values may vary.

Examples

Coordinate values may be years expressed as a decimal year in the Gregorian calendar. For example, 2017-03-25 in the Gregorian calendar is epoch 2017.23. The number of days between two integer values may vary because of leap years. For a coordinate system using this convention, TimeCS.getTemporalUnit() should return ChronoUnit.YEARS.

Coordinate values may be a count of months since a given year. For example, 1 = January 2000, 2 = February 2000, 3 = March 2000, …, 13 = January 2001, 14 = February 2001, etc. The number of days between two integer values may very because of different month lengths. For a coordinate system using this convention, TimeCS.getTemporalUnit() should return ChronoUnit.MONTHS.

Method Details

values

public static CoordinateDataType[] values()

Returns the list of CoordinateDataTypes.

Returns:

the list of codes declared in the current JVM.

family

public CoordinateDataType[] family()

Returns the list of codes of the same kind as this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<CoordinateDataType>

Returns:

all code values for this code list.

valueOf

public static CoordinateDataType valueOf(String code)

Returns the coordinate data type that matches the given string, or returns a new one if none match it. This methods returns the first instance (in declaration order) for which the name is equals, ignoring case, to the given name. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - the name of the code to fetch or to create.

Returns:

a code matching the given name.