Module org.opengis.geoapi

Package org.opengis.referencing

Interface ReferenceSystem

All Superinterfaces:

IdentifiedObject

All Known Subinterfaces:

CompoundCRS, CoordinateReferenceSystem, DerivedCRS, EngineeringCRS, GeneralDerivedCRS, GeocentricCRS, GeodeticCRS, GeographicCRS, ImageCRS, ParametricCRS, ProjectedCRS, SingleCRS, TemporalCRS, VerticalCRS

All Known Implementing Classes:

SimpleCRS, SimpleCRS.Geographic, SimpleCRS.Temporal, SimpleCRS.Vertical

@UML(identifier="RS_ReferenceSystem",
     specification=ISO_19115,
     version=2003)
public interface ReferenceSystem
extends IdentifiedObject

Description of a spatial and temporal reference system used by a dataset. A reference system contains the metadata required to interpret spatial location information unambiguously. Two methods to describe spatial location are distinguished:

• Spatial referencing by geographic identifier. Geographic identifiers are location descriptors such as addresses and grid indexes.
• Spatial referencing by coordinates. This specialized case is handled by the CoordinateReferenceSystem subtype.

Reference systems contain the following properties (including those inherited from the IdentifiedObject parent interface):

• A name (e.g. “WGS 84 / World Mercator”).
• Alternative names or aliases, sometimes used for abbreviations.
• Identifiers allocated by authorities (e.g. “EPSG:3395”).
• The domain of validity in which this reference system is valid (e.g. “World - between 80°S and 84°N”).
• The scope or intended usage for this reference system (e.g. “Very small scale mapping”).
• Remarks about this object, including data source information (e.g. “Euro-centric view of world excluding polar areas”).

Since:

1.0

See Also:

• CoordinateReferenceSystem

Departure from OGC/ISO abstract specification:

Departure for harmonization between different specifications

The type defined in ISO 19115 has no relationship with ISO 19111. GeoAPI redefines this type as a subtype of IdentifiedObject and the common parent for org.opengis.referencing.crs.CoordinateReferenceSystem and org.opengis.referencing.gazetteer.ReferenceSystemUsingIdentifiers. This change makes this interface closer to the legacy ISO 19115:2003 RS_ReferenceSystem than to ISO 19115:2015 MD_ReferenceSystem.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DOMAIN_OF_VALIDITY_KEY	Key for the "domainOfValidity" property to be given to the object factory createFoo(Map, ...) methods.
static final String	SCOPE_KEY	Key for the "scope" property to be given to the object factory createFoo(Map, ...) methods.

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Method Summary

Modifier and Type	Method	Description
default Extent	getDomainOfValidity()	Area or region or timeframe in which this (coordinate) reference system is valid.
default InternationalString	getScope()	Description of domain of usage, or limitations of usage, for which this Reference System object is valid.

Methods inherited from interface IdentifiedObject

getAlias, getIdentifiers, getName, getRemarks, toWKT

Field Details

DOMAIN_OF_VALIDITY_KEY

static final String DOMAIN_OF_VALIDITY_KEY

Key for the "domainOfValidity" property to be given to the object factory createFoo(Map, ...) methods. This is used for setting the value to be returned by getDomainOfValidity().

See Also:

• getDomainOfValidity()
• Constant Field Values

SCOPE_KEY

static final String SCOPE_KEY

Key for the "scope" property to be given to the object factory createFoo(Map, ...) methods. This is used for setting the value to be returned by getScope().

See Also:

• getScope()
• Constant Field Values

Method Details

getDomainOfValidity

@UML(identifier="domainOfValidity",
     obligation=OPTIONAL,
     specification=ISO_19111)
default Extent getDomainOfValidity()

Area or region or timeframe in which this (coordinate) reference system is valid.

Returns:

the reference system valid domain, or null if not available.

Departure from OGC/ISO abstract specification:

Departure for historical reason

This method has been kept conformant with the specification published in 2003. Later revisions changed the multiplicity, so the return type should now be a collection. The singleton has been preserved in GeoAPI for historical reasons, and also because the Extent attributes already allow collections.

getScope

@UML(identifier="SC_CRS.scope",
     obligation=OPTIONAL,
     specification=ISO_19111)
default InternationalString getScope()

Description of domain of usage, or limitations of usage, for which this Reference System object is valid.

Returns:

the domain of usage, or null if none.

Departure from OGC/ISO abstract specification:

Departure for historical reason

This method was initially derived from the ISO 19111 specification published in 2003. Later revision (ISO 19111:2007) differs in 3 aspects:

• ISO 19111:2007 moved this property from this type to the SC_CRS subtype. GeoAPI keeps this property here for historical reasons.
• ISO 19111:2007 changed the obligation from optional to mandatory and requires the value to be "not known" if the scope is unknown. GeoAPI lefts the obligation unchanged: optional with null value for unknown scope.
• ISO 19111:2007 changed the multiplicity from singleton to a collection. GeoAPI keeps the singleton type for historical reasons.