Module org.opengis.geoapi

Package org.opengis.metadata.spatial

Interface Dimension

@Classifier(DATATYPE)
@UML(identifier="MD_Dimension",
     specification=ISO_19115)
public interface Dimension

Axis properties.

Since:

2.0

Method Summary

Modifier and Type	Method	Description
default InternationalString	getDimensionDescription()	Description of the axis.
DimensionNameType	getDimensionName()	Name of the axis.
Integer	getDimensionSize()	Number of elements along the axis.
default InternationalString	getDimensionTitle()	Enhancement / modifier of the dimension name.
default Double	getResolution()	Degree of detail in the grid dataset.

Method Details

getDimensionName

@UML(identifier="dimensionName",
     obligation=MANDATORY,
     specification=ISO_19115)
DimensionNameType getDimensionName()

Name of the axis.

Returns:

name of the axis.

getDimensionSize

@UML(identifier="dimensionSize",
     obligation=MANDATORY,
     specification=ISO_19115)
Integer getDimensionSize()

Number of elements along the axis.

Returns:

number of elements along the axis.

getResolution

@UML(identifier="resolution",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Double getResolution()

Degree of detail in the grid dataset.

Upcoming API change — units of measurement
The return type of this method may change in GeoAPI 4.0. It may be replaced by the Quantity type in order to provide unit of measurement together with the value.

Returns:

degree of detail in the grid dataset, or null.

Unit:

Measure

getDimensionTitle

@UML(identifier="dimensionTitle",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getDimensionTitle()

Enhancement / modifier of the dimension name.

Example: dimensionName = "column", dimensionTitle = "longitude"

Returns:

enhancement / modifier of the dimension name, or null if none.

Since:

3.1

getDimensionDescription

@UML(identifier="dimensionDescription",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getDimensionDescription()

Description of the axis.

Returns:

description of the axis, or null if none.

Since:

3.1