GeoAPI 1.0
Build 2004-05-18

org.opengis.referencing.datum
Interface DatumAuthorityFactory

All Superinterfaces:
AuthorityFactory

public interface DatumAuthorityFactory
extends AuthorityFactory

Creates datum objects using authority codes. External authorities are used to manage definitions of objects used in this interface. The definitions of these objects are referenced using code strings. A commonly used authority is EPSG, which is also used in the GeoTIFF standard.

Version:
Implementation specification 1.0
Author:
OpenGIS® consortium
See Also:
CSAuthorityFactory, CRSAuthorityFactory
UML identifier (abstract type): CS_CoordinateSystemAuthorityFactory

Method Summary
 Datum createDatum(String code)
          Returns an arbitrary datum from a code.
 Ellipsoid createEllipsoid(String code)
          Returns an ellipsoid from a code.
 EngineeringDatum createEngineeringDatum(String code)
          Creates a engineering datum from a code.
 GeodeticDatum createGeodeticDatum(String code)
          Returns a geodetic datum from a code.
 ImageDatum createImageDatum(String code)
          Creates a image datum from a code.
 PrimeMeridian createPrimeMeridian(String code)
          Returns a prime meridian from a code.
 TemporalDatum createTemporalDatum(String code)
          Creates a temporal datum from a code.
 VerticalDatum createVerticalDatum(String code)
          Creates a vertical datum from a code.
 String geoidFromWktName(String wkt)
          Gets the Geoid code from a WKT name.
 String wktFromGeoidName(String geoid)
          Gets the WKT name of a Geoid.
 
Methods inherited from interface AuthorityFactory
createObject, getAuthority, getAuthorityCodes, getDescriptionText, getFactory
 

Method Detail

createDatum

Datum createDatum(String code)
                  throws FactoryException
Returns an arbitrary datum from a code. If the datum type is know at compile time, it is recommended to invoke the most precise method instead of this one (for example  createGeodeticDatum(code)  instead of  createDatum(code)  if the caller know he is asking for a geodetic datum).

Parameters:
code - Value allocated by authority.
Throws:
NoSuchAuthorityCodeException - if the specified code was not found.
FactoryException - if the object creation failed for some other reason.
See Also:
createGeodeticDatum(java.lang.String), createVerticalDatum(java.lang.String), createTemporalDatum(java.lang.String)

createEngineeringDatum

EngineeringDatum createEngineeringDatum(String code)
                                        throws FactoryException
Creates a engineering datum from a code.

Parameters:
code - Value allocated by authority.
Throws:
NoSuchAuthorityCodeException - if the specified code was not found.
FactoryException - if the object creation failed for some other reason.
See Also:
CRSAuthorityFactory.createEngineeringCRS(java.lang.String)

createImageDatum

ImageDatum createImageDatum(String code)
                            throws FactoryException
Creates a image datum from a code.

Parameters:
code - Value allocated by authority.
Throws:
NoSuchAuthorityCodeException - if the specified code was not found.
FactoryException - if the object creation failed for some other reason.
See Also:
CRSAuthorityFactory.createImageCRS(java.lang.String)

createVerticalDatum

VerticalDatum createVerticalDatum(String code)
                                  throws FactoryException
Creates a vertical datum from a code.

Parameters:
code - Value allocated by authority.
Throws:
NoSuchAuthorityCodeException - if the specified code was not found.
FactoryException - if the object creation failed for some other reason.
See Also:
CRSAuthorityFactory.createVerticalCRS(java.lang.String)
UML identifier (operation): createVerticalDatum  in 1.0 specification

createTemporalDatum

TemporalDatum createTemporalDatum(String code)
                                  throws FactoryException
Creates a temporal datum from a code.

Parameters:
code - Value allocated by authority.
Throws:
NoSuchAuthorityCodeException - if the specified code was not found.
FactoryException - if the object creation failed for some other reason.
See Also:
CRSAuthorityFactory.createTemporalCRS(java.lang.String)

createGeodeticDatum

GeodeticDatum createGeodeticDatum(String code)
                                  throws FactoryException
Returns a geodetic datum from a code.

Parameters:
code - Value allocated by authority.
Throws:
NoSuchAuthorityCodeException - if the specified code was not found.
FactoryException - if the object creation failed for some other reason.
See Also:
createEllipsoid(java.lang.String), createPrimeMeridian(java.lang.String), CRSAuthorityFactory.createGeographicCRS(java.lang.String), CRSAuthorityFactory.createProjectedCRS(java.lang.String)
UML identifier (operation): createHorizontalDatum  in 1.0 specification

createEllipsoid

Ellipsoid createEllipsoid(String code)
                          throws FactoryException
Returns an ellipsoid from a code.

Parameters:
code - Value allocated by authority.
Throws:
NoSuchAuthorityCodeException - if the specified code was not found.
FactoryException - if the object creation failed for some other reason.
See Also:
createGeodeticDatum(java.lang.String)
UML identifier (operation): createEllipsoid  in 1.0 specification

createPrimeMeridian

PrimeMeridian createPrimeMeridian(String code)
                                  throws FactoryException
Returns a prime meridian from a code.

Parameters:
code - Value allocated by authority.
Throws:
NoSuchAuthorityCodeException - if the specified code was not found.
FactoryException - if the object creation failed for some other reason.
See Also:
createGeodeticDatum(java.lang.String)
UML identifier (operation): createPrimeMeridian  in 1.0 specification

geoidFromWktName

String geoidFromWktName(String wkt)
Gets the Geoid code from a WKT name. In the OGC definition of WKT horizontal datums, the geoid is referenced by a quoted string, which is used as a key value. This method converts the key value string into a code recognized by this authority.

Parameters:
wkt - Name of geoid defined by OGC (e.g. "European_Datum_1950").
See Also:
createGeodeticDatum(java.lang.String)
UML identifier (operation): geoidFromWKTName  in 1.0 specification

REVISIT OPEN ISSUE (a GeoAPI comment)
WKT are not yet specified in this 2.0 version of interfaces. Does the OGC names still the same?

wktFromGeoidName

String wktFromGeoidName(String geoid)
Gets the WKT name of a Geoid. In the OGC definition of WKT horizontal datums, the geoid is referenced by a quoted string, which is used as a key value. This method gets the OGC WKT key value from a geoid code.

Parameters:
geoid - Code value for geoid allocated by authority.
See Also:
createGeodeticDatum(java.lang.String)
UML identifier (operation): wktGeoidName  in 1.0 specification

REVISIT OPEN ISSUE (a GeoAPI comment)
WKT are not yet specified in this 2.0 version of interfaces. Does the OGC names still the same?

GeoAPI 1.0
Build 2004-05-18

Symbols, terms and definitions
Copyright OpenGIS® Consortium