org.opengis.referencing
Interface ReferenceSystem

All Superinterfaces:
IdentifiedObject
All Known Subinterfaces:
CompoundCRS, CoordinateReferenceSystem, DerivedCRS, EngineeringCRS, GeneralDerivedCRS, GeocentricCRS, GeodeticCRS, GeographicCRS, ImageCRS, ProjectedCRS, SingleCRS, TemporalCRS, VerticalCRS

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

Description of a spatial and temporal reference system used by a dataset.

Since:
GeoAPI 1.0
See Also:
CoordinateReferenceSystem
Departure from OGC/ISO specification:
This interface was initially derived from an ISO 19111 specification published in 2003. Later revisions (in 2005) rely on an interface defined in ISO 19115 instead. The annotations were updated accordingly, but this interface is still defined in the referencing package instead of the metadata package for this historical reason.

Field Summary
static String DOMAIN_OF_VALIDITY_KEY
          Key for the "domainOfValidity" property to be given to the object factory createFoo(…) methods.
static String SCOPE_KEY
          Key for the "scope" property to be given to the object factory createFoo(…) methods.
 
Fields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
 
Method Summary
 Extent getDomainOfValidity()
          Area or region or timeframe in which this (coordinate) reference system is valid.
 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 Detail

DOMAIN_OF_VALIDITY_KEY

static final String DOMAIN_OF_VALIDITY_KEY
Key for the "domainOfValidity" property to be given to the object factory createFoo(…) methods. This is used for setting the value to be returned by getDomainOfValidity().

Since:
GeoAPI 2.1
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(…) methods. This is used for setting the value to be returned by getScope().

See Also:
getScope(), Constant Field Values
Method Detail

getDomainOfValidity

@UML(identifier="domainOfValidity",
     obligation=OPTIONAL,
     specification=ISO_19111)
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.
Since:
GeoAPI 2.1
Departure from OGC/ISO specification:
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)
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 specification:
This method has been kept conformant with the specification published in 2003. A later revision moved this attribute to subclasses, but GeoAPI keeps this method here for historical reasons. The obligation is still optional, as opposed to ISO 19111:2007 which makes this attribute mandatory while mandating the text "not known" if the scope is unknown. In addition, the return value of this method is still a singleton as in the 2003 version, as opposed to the 2007 version which mandates a collection. The proposed change is still under review.


Copyright © 1994-2011 Open Geospatial Consortium. All Rights Reserved.