Package org.opengis.referencing
Interface IdentifiedObject
-
- All Known Subinterfaces:
AffineCS
,CartesianCS
,CompoundCRS
,ConcatenatedOperation
,ConicProjection
,Conversion
,CoordinateOperation
,CoordinateReferenceSystem
,CoordinateSystem
,CoordinateSystemAxis
,CylindricalCS
,CylindricalProjection
,Datum
,DerivedCRS
,Ellipsoid
,EllipsoidalCS
,EngineeringCRS
,EngineeringDatum
,GeneralDerivedCRS
,GeneralParameterDescriptor
,GeocentricCRS
,GeodeticCRS
,GeodeticDatum
,GeographicCRS
,ImageCRS
,ImageDatum
,LinearCS
,OperationMethod
,ParameterDescriptor<T>
,ParameterDescriptorGroup
,ParametricCRS
,ParametricCS
,ParametricDatum
,PassThroughOperation
,PlanarProjection
,PolarCS
,PrimeMeridian
,ProjectedCRS
,Projection
,ReferenceSystem
,SingleCRS
,SingleOperation
,SphericalCS
,TemporalCRS
,TemporalDatum
,TimeCS
,Transformation
,UserDefinedCS
,VerticalCRS
,VerticalCS
,VerticalDatum
@Classifier(ABSTRACT) @UML(identifier="IO_IdentifiedObject", specification=ISO_19111) public interface IdentifiedObject
Identification and remarks information for a reference system or CRS-related object. Identified objects contain the following properties:- A name (e.g. “North American Datum of 1983”).
- Alternative names or aliases (e.g. “NAD83” abbreviation).
- Identifiers allocated by authorities (e.g. a register of geodetic codes and parameters might give the NAD83 datum a unique code of “6269”).
- Remarks about this object, including data source information.
IdentifiedObject
sub-types are:- Geodetic Datum (e.g. “World Geodetic System 1984”),
- Operation Method (e.g. “Mercator (variant A)”),
- Coordinate Reference System (e.g. “WGS 84 / World Mercator”).
CRSAuthorityFactory
is used to create an object, the authority and authority code values shall be set to the authority name of the factory object, and the authority code supplied by the client, respectively. The other values may or may not be set. If the authority is EPSG, the implementer may consider using the corresponding metadata values in the EPSG tables.- Since:
- 2.0
Departure from OGC/ISO specification:
ISO 19111 defines two types,IO_IdentifiedObjectBase
andIO_IdentifiedObject
, as a workaround for introducing a base type for thename
,identifier
,alias
andremarks
properties without changing theRS_ReferenceSystem
definition inherited from ISO 19115. Since GeoAPI replaces ISO 19115 CRS definitions by the ISO 19111 ones for providing a unified model, it does not need this workaround. Consequently GeoAPI mergesIO_IdentifiedObjectBase
andIO_IdentifiedObject
into this single interface.
-
-
Field Summary
Fields Modifier and Type Field Description static String
ALIAS_KEY
static String
IDENTIFIERS_KEY
static String
NAME_KEY
static String
REMARKS_KEY
-
Method Summary
Modifier and Type Method Description default Collection<GenericName>
getAlias()
Alternative names by which this object is identified.default Set<ReferenceIdentifier>
getIdentifiers()
An identifier which references elsewhere the object's defining information.ReferenceIdentifier
getName()
The primary name by which this object is identified.default InternationalString
getRemarks()
Comments on or information about this object, including data source information.default String
toWKT()
Returns a Well-Known Text (WKT) for this object.
-
-
-
Field Detail
-
NAME_KEY
static final String NAME_KEY
Key for the"name"
property to be given to the object factorycreateFoo(Map, ...)
methods. This is used for setting the value to be returned bygetName()
.- See Also:
getName()
, Constant Field Values
-
ALIAS_KEY
static final String ALIAS_KEY
Key for the"alias"
property to be given to the object factorycreateFoo(Map, ...)
methods. This is used for setting the value to be returned bygetAlias()
.- See Also:
getAlias()
, Constant Field Values
-
IDENTIFIERS_KEY
static final String IDENTIFIERS_KEY
Key for the"identifiers"
property to be given to the object factorycreateFoo(Map, ...)
methods. This is used for setting the value to be returned bygetIdentifiers()
.- See Also:
getIdentifiers()
, Constant Field Values
-
REMARKS_KEY
static final String REMARKS_KEY
Key for the"remarks"
property to be given to the object factorycreateFoo(Map, ...)
methods. This is used for setting the value to be returned bygetRemarks()
.- See Also:
getRemarks()
, Constant Field Values
-
-
Method Detail
-
getName
@UML(identifier="name", obligation=MANDATORY, specification=ISO_19111) ReferenceIdentifier getName()
The primary name by which this object is identified.Upcoming API change — generalization
As of ISO 19115:2014,ReferenceIdentifier
has been merged with itsIdentifier
parent interface. Consequently this method return type will be changed toIdentifier
in GeoAPI 4.0.- Returns:
- the primary name.
-
getAlias
@UML(identifier="alias", obligation=OPTIONAL, specification=ISO_19111) default Collection<GenericName> getAlias()
Alternative names by which this object is identified.- Returns:
- alternative names and abbreviations, or an empty collection if there is none.
-
getIdentifiers
@UML(identifier="identifier", obligation=OPTIONAL, specification=ISO_19111) default Set<ReferenceIdentifier> getIdentifiers()
An identifier which references elsewhere the object's defining information. Alternatively an identifier by which this object can be referenced.Upcoming API change — generalization
As of ISO 19115:2014,ReferenceIdentifier
has been merged with itsIdentifier
parent interface. Consequently the element type will be changed toIdentifier
in GeoAPI 4.0.- Returns:
- this object identifiers, or an empty collection if there is none.
-
getRemarks
@UML(identifier="remarks", obligation=OPTIONAL, specification=ISO_19111) default InternationalString getRemarks()
Comments on or information about this object, including data source information.- Returns:
- the remarks, or
null
if none.
-
toWKT
default String toWKT() throws UnsupportedOperationException
Returns a Well-Known Text (WKT) for this object. Well-Known Texts (WKT) may come in two formats:- The current standard, WKT 2, is defined by ISO 19162.
- The legacy format, WKT 1, was defined by OGC 01-009 and is shown using Extended Backus Naur Form (EBNF) here.
- Returns:
- the Well-Known Text (WKT) for this object.
- Throws:
UnsupportedOperationException
- if this object can not be formatted as WKT.- See Also:
CRSFactory.createFromWKT(String)
Departure from OGC/ISO specification:
This method is not part of the OGC specification. It has been added in order to provide the converse of theCRSFactory.createFromWKT(String)
method, which is defined in OGC 01-009.
-
-