Package org.geotools.api.referencing.datum

Interface DatumAuthorityFactory

All Superinterfaces:

AuthorityFactory, Factory

All Known Implementing Classes:

Abstract_URI_AuthorityFactory, AbstractAuthorityMediator, AbstractCachedAuthorityFactory, AbstractEpsgFactory, AbstractEpsgMediator, AccessDialectEpsgFactory, AllAuthoritiesFactory, AnsiDialectEpsgFactory, CachedAuthorityDecorator, DirectEpsgFactory, FactoryUsingAnsiSQL, FactoryUsingSQL, HsqlDialectEpsgMediator, HTTP_AuthorityFactory, HTTP_URI_AuthorityFactory, LongitudeFirstEpsgDecorator, LongitudeFirstFactory, ManyAuthoritiesFactory, PropertyAuthorityFactory, ThreadedEpsgFactory, ThreadedHsqlEpsgFactory, ThreadedPostgreSQLEpsgFactory, URN_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.

Since:

GeoAPI 1.0

Author:

Martin Desruisseaux (IRD)

See Also:

CSAuthorityFactory, CRSAuthorityFactory

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from interface AuthorityFactory

createObject, getAuthority, getAuthorityCodes, getDescriptionText

Methods inherited from interface Factory

getVendor

Method Detail

createDatum

Datum createDatum(String code)
           throws NoSuchAuthorityCodeException,
                  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.

Returns:

The datum for the given code.

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 NoSuchAuthorityCodeException,
                                        FactoryException

Creates a engineering datum from a code.

Parameters:

code - Value allocated by authority.

Returns:

The datum for the given code.

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 NoSuchAuthorityCodeException,
                            FactoryException

Creates a image datum from a code.

Parameters:

code - Value allocated by authority.

Returns:

The datum for the given code.

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 NoSuchAuthorityCodeException,
                                  FactoryException

Creates a vertical datum from a code.

Parameters:

code - Value allocated by authority.

Returns:

The datum for the given code.

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)

createTemporalDatum

TemporalDatum createTemporalDatum(String code)
                           throws NoSuchAuthorityCodeException,
                                  FactoryException

Creates a temporal datum from a code.

Parameters:

code - Value allocated by authority.

Returns:

The datum for the given code.

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 NoSuchAuthorityCodeException,
                                  FactoryException

Returns a geodetic datum from a code.

Parameters:

code - Value allocated by authority.

Returns:

The datum for the given code.

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)

createEllipsoid

Ellipsoid createEllipsoid(String code)
                   throws NoSuchAuthorityCodeException,
                          FactoryException

Returns an ellipsoid from a code.

Parameters:

code - Value allocated by authority.

Returns:

The ellipsoid for the given code.

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)

createPrimeMeridian

PrimeMeridian createPrimeMeridian(String code)
                           throws NoSuchAuthorityCodeException,
                                  FactoryException

Returns a prime meridian from a code.

Parameters:

code - Value allocated by authority.

Returns:

The prime meridian for the given code.

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)