Package org.geotools.api.referencing
Interface IdentifiedObject
- All Known Subinterfaces:
AffineCS
,Calendar
,CartesianCS
,Clock
,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
,Operation
,OperationMethod
,OrdinalReferenceSystem
,ParameterDescriptor<T>
,ParameterDescriptorGroup
,PassThroughOperation
,PlanarProjection
,PolarCS
,PrimeMeridian
,ProjectedCRS
,Projection
,ReferenceSystem
,SingleCRS
,SingleOperation
,SpatialReferenceSystemUsingGeographicIdentifier
,SphericalCS
,TemporalCoordinateSystem
,TemporalCRS
,TemporalDatum
,TemporalReferenceSystem
,TimeCS
,Transformation
,UserDefinedCS
,VerticalCRS
,VerticalCS
,VerticalDatum
- All Known Implementing Classes:
AbstractCoordinateOperation
,AbstractCRS
,AbstractCS
,AbstractDatum
,AbstractDerivedCRS
,AbstractIdentifiedObject
,AbstractParameterDescriptor
,AbstractReferenceSystem
,AbstractSingleCRS
,AlbersEqualArea.Provider
,AzimuthalEquidistant.Provider
,CassiniSoldner.Provider
,CylindricalEqualArea.BehrmannProvider
,CylindricalEqualArea.LambertCylindricalEqualAreaProvider
,CylindricalEqualArea.Provider
,DefaultAffineCS
,DefaultCalendar
,DefaultCartesianCS
,DefaultClock
,DefaultCompoundCRS
,DefaultCompoundCS
,DefaultConcatenatedOperation
,DefaultConicProjection
,DefaultConversion
,DefaultCoordinateSystemAxis
,DefaultCylindricalCS
,DefaultCylindricalProjection
,DefaultDerivedCRS
,DefaultEllipsoid
,DefaultEllipsoidalCS
,DefaultEngineeringCRS
,DefaultEngineeringDatum
,DefaultGeocentricCRS
,DefaultGeodeticDatum
,DefaultGeographicCRS
,DefaultImageCRS
,DefaultImageDatum
,DefaultLinearCS
,DefaultOperation
,DefaultOperationMethod
,DefaultOrdinalReferenceSystem
,DefaultParameterDescriptor
,DefaultParameterDescriptorGroup
,DefaultPassThroughOperation
,DefaultPlanarProjection
,DefaultPolarCS
,DefaultPrimeMeridian
,DefaultProjectedCRS
,DefaultProjection
,DefaultSingleOperation
,DefaultSphericalCS
,DefaultTemporalCoordinateSystem
,DefaultTemporalCRS
,DefaultTemporalDatum
,DefaultTemporalReferenceSystem
,DefaultTimeCS
,DefaultTransformation
,DefaultUserDefinedCS
,DefaultVerticalCRS
,DefaultVerticalCS
,DefaultVerticalDatum
,DefiningConversion
,EarthGravitationalModel.Provider
,EckertIV.Provider
,EqualArea.Provider
,EquidistantConic.Provider
,EquidistantCylindrical.Provider
,EquidistantCylindrical.SphericalProvider
,ExponentialTransform1D.Provider
,ExtendedImagingParameterDescriptors
,GeneralOblique.Provider
,GeocentricTransform.Provider
,GeocentricTransform.ProviderInverse
,GeocentricTranslation.Provider
,GeocentricTranslation.ProviderFrameRotation
,GeocentricTranslation.ProviderSevenParam
,GeostationarySatellite.Provider
,Gnomonic.Provider
,Homolosine.Provider
,HotineObliqueMercator.Provider
,HotineObliqueMercator.Provider_TwoPoint
,ImagingParameterDescriptors
,Krovak.NorthProvider
,Krovak.Provider
,LambertAzimuthalEqualArea.Provider
,LambertConformal1SP.Provider
,LambertConformal2SP.Provider
,LambertConformalBelgium.Provider
,LambertConformalEsriProvider
,LogarithmicTransform1D.Provider
,MapProjection.AbstractProvider
,MathTransformProvider
,MatrixParameterDescriptors
,MatrixParameters
,Mercator1SP.Provider
,Mercator2SP.Provider
,MercatorPseudoProvider
,MeteosatSG.Provider
,Mollweide.MollweideProvider
,Mollweide.WagnerIVProvider
,Mollweide.WagnerVProvider
,MolodenskiTransform.Provider
,MolodenskiTransform.ProviderAbridged
,NADCONTransform.Provider
,NewZealandMapGrid.Provider
,NTv2Transform.Provider
,ObliqueMercator.Provider
,ObliqueMercator.Provider_TwoPoint
,ObliqueStereographic.Provider
,Orthographic.Provider
,PlateCarree.Provider
,PolarStereographic.ProviderA
,PolarStereographic.ProviderB
,PolarStereographic.ProviderNorth
,PolarStereographic.ProviderSouth
,Polyconic.Provider
,ProjectiveTransform.ProviderAffine
,ProjectiveTransform.ProviderLongitudeRotation
,Robinson.Provider
,RotatedPole.Provider
,SimilarityTransformProvider
,Sinusoidal.Provider
,Stereographic.Provider
,TransverseMercator.Provider
,TransverseMercator.Provider_SouthOrientated
,WarpTransform2DProvider
,WinkelTripel.AitoffProvider
,WinkelTripel.WinkelProvider
,WorldVanDerGrintenI.Provider
public interface IdentifiedObject
Supplementary identification and remarks information for a CRS or CRS-related object. When
CRSAuthorityFactory
is used to create an object, the
authority and authority code
values should 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:
- GeoAPI 2.0
- Author:
- Martin Desruisseaux (IRD)
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptiongetAlias()
An alternative name by which this object is identified.An identifier which references elsewhere the object's defining information.getName()
The primary name by which this object is identified.Comments on or information about this object, including data source information.toWKT()
Returns a Well Known Text (WKT) for this object.
-
Field Details
-
NAME_KEY
Key for the"name"
property to be given to the object factorycreateFoo(…)
methods. This is used for setting the value to be returned bygetName()
.- See Also:
-
ALIAS_KEY
Key for the"alias"
property to be given to the object factorycreateFoo(…)
methods. This is used for setting the value to be returned bygetAlias()
.- See Also:
-
IDENTIFIERS_KEY
Key for the"identifiers"
property to be given to the object factorycreateFoo(…)
methods. This is used for setting the value to be returned bygetIdentifiers()
.- See Also:
-
REMARKS_KEY
Key for the"remarks"
property to be given to the object factorycreateFoo(…)
methods. This is used for setting the value to be returned bygetRemarks()
.- See Also:
-
-
Method Details
-
getName
ReferenceIdentifier getName()The primary name by which this object is identified.- Returns:
- The primary name.
-
getAlias
Collection<GenericName> getAlias()An alternative name by which this object is identified.- Returns:
- The aliases, or an empty collection if there is none.
-
getIdentifiers
Set<ReferenceIdentifier> getIdentifiers()An identifier which references elsewhere the object's defining information. Alternatively an identifier by which this object can be referenced.- Returns:
- This object identifiers, or an empty set if there is none.
-
getRemarks
InternationalString getRemarks()Comments on or information about this object, including data source information.- Returns:
- The remarks, or
null
if none.
-
toWKT
Returns a Well Known Text (WKT) for this object. This operation may fails if an object is too complex for the WKT format capability (for example an engineering CRS with different unit for each axis).- Returns:
- The Well Know Text for this object.
- Throws:
UnsupportedOperationException
- If this object can't be formatted as WKT.
-