org.cts

Interface Identifiable

All Known Subinterfaces:

CoordinateOperation, CoordinateReferenceSystem, Datum, GeocentricTransformation, ParamBasedTransformation

All Known Implementing Classes:

AbstractCoordinateOperation, AbstractDatum, AlbersEqualArea, Altitude2EllipsoidalHeight, CassiniSoldner, ChangeCoordinateDimension, CompoundCRS, CoordinateOperationSequence, CoordinateRounding, CoordinateSwitch, CylindricalEqualArea, Ellipsoid, EquidistantCylindrical, FrenchGeocentricNTF2RGF, GaussSchreiberTransverseMercator, Geocentric2Geographic, GeocentricCRS, GeocentricTransformationSequence, GeocentricTranslation, GeodeticCRS, GeodeticDatum, Geographic2DCRS, Geographic2Geocentric, Geographic3DCRS, IdentifiableComponent, Identifier, Identity, IterativeTransformation, Krovak, LambertAzimuthalEqualArea, LambertConicConformal1SP, LambertConicConformal2SP, LoadMemorizeCoordinate, LongitudeRotation, MemorizeCoordinate, Mercator1SP, MillerCylindrical, NewZealandMapGrid, NTv2GridShiftTransformation, ObliqueMercator, ObliqueStereographicAlternative, OppositeCoordinate, Polyconic, PrimeMeridian, ProjectedCRS, Projection, SevenParameterTransformation, Stereographic, SwissObliqueMercator, TransverseMercator, Unit, UnitConversion, UniversalTransverseMercator, UniversalTransverseMercatorAuto, VerticalCRS, VerticalDatum

public interface Identifiable

Identifiable is the interface implemented by geodetic objects issued from registries (like the epsg database).

Datums, Ellipsoid and CoordinateReferenceSystems are Identifiable objects.

Well known geodetic databases are :

• EPSG
• IGN-F

Identifiable components have three main characteristics :

• A namespace
• An identifier which is relative to this namespace
• A name

Examples of namespaces for spatial reference systems are :

• EPSG
• http://www.opengis.net/gml/srs/epsg.xml
• urn:ogc:def:crs:EPSG:6.3

The syntax recommended by ogc for epsg object is described in rfc5165.

Author:

Michaël Michaud

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT Value used as a dafault name for objects without name.
static String	LOCAL Namespace used to identify objects having no reference in an external persistent database.
static String	UNKNOWN Value used for objects with an unknown name.

Method Summary

Modifier and Type	Method and Description
boolean	addAlias(Identifiable alias) Adds an alias
void	addRemark(String new_remark) Add remarks.
List<Identifiable>	getAliases() Get aliases
String	getAuthorityKey() Returns this authority's id (must be unique in this Identifiable's namespace).
String	getAuthorityName() Returns the authority name of the CRS as a String.
String	getCode() Returns the code formed with the namespace URI, ':' and the id value of the identifier (ex.
String	getName() Returns the full readable name of this object.
String	getRemarks() Returns remarks.
String	getShortName() Returns the short name of this Identifiable.
void	setRemarks(String remarks) Change the remarks.
void	setShortName(String shortName) Change the short name for this Identifiable.

Field Detail

LOCAL

static final String LOCAL

Namespace used to identify objects having no reference in an external persistent database.

See Also:

Constant Field Values

DEFAULT

static final String DEFAULT

Value used as a dafault name for objects without name.

See Also:

Constant Field Values

UNKNOWN

static final String UNKNOWN

Value used for objects with an unknown name.

See Also:

Constant Field Values

Method Detail

getAuthorityName

String getAuthorityName()

Returns the authority name of the CRS as a String.(ex : EPSG)

The String must follow the syntax of a URI (ex. urn:ogc:def:crs:OGC:1.3). You'll find more on the URI syntax here.

getAuthorityKey

String getAuthorityKey()

Returns this authority's id (must be unique in this Identifiable's namespace). (ex : 27572)

getCode

String getCode()

Returns the code formed with the namespace URI, ':' and the id value of the identifier (ex. EPSG:27572).

Returns:

a String of the form namespace:id

getName

String getName()

Returns the full readable name of this object.

getShortName

String getShortName()

Returns the short name of this Identifiable. A short name should have less than 16 characters whenever possible, and should never exceed 48 characters.

setShortName

void setShortName(String shortName)

Change the short name for this Identifiable. A short name should have less than 16 characters whenever possible, and should never exceed 48 characters.

Parameters:

shortName - the short name to give to the identifiable

getRemarks

String getRemarks()

Returns remarks.

setRemarks

void setRemarks(String remarks)

Change the remarks.

Parameters:

remarks - the new remarks of the identifiable

addRemark

void addRemark(String new_remark)

Add remarks.

Parameters:

new_remark - the remark to add

getAliases

List<Identifiable> getAliases()

Get aliases

addAlias

boolean addAlias(Identifiable alias)

Adds an alias

Parameters:

alias - an alias for this object