Module org.opengis.geoapi

Package org.opengis.referencing.datum

Interface DatumAuthorityFactory

All Superinterfaces:

AuthorityFactory, Factory

All Known Implementing Classes:

PseudoEpsgFactory

@UML(identifier="CS_CoordinateSystemAuthorityFactory",
     specification=OGC_01009)
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 the EPSG geodetic registry.

Default methods

All create(…) methods in this interface are optional. If a method is not overridden by the implementer, the default is:

• For methods creating a sub-type of Datum, delegate to createDatum(String) then check the returned object type.
• For all other methods, throw an UnimplementedServiceException with a message saying that the type or service is not supported.

Since:

1.0

See Also:

• CSAuthorityFactory
• CRSAuthorityFactory

Method Summary

Modifier and Type	Method	Description
default Datum	createDatum(String code)	Returns an arbitrary datum from a code.
default Ellipsoid	createEllipsoid(String code)	Returns an ellipsoid from a code.
default EngineeringDatum	createEngineeringDatum(String code)	Returns a engineering datum from a code.
default GeodeticDatum	createGeodeticDatum(String code)	Returns a geodetic reference frame from a code.
default ImageDatum	createImageDatum(String code)	Deprecated. ImageDatum is replaced by EngineeringDatum as of ISO 19111:2019.
default IdentifiedObject	createObject(String code)	Deprecated, for removal: This API element is subject to removal in a future version. This method is ambiguous.
default ParametricDatum	createParametricDatum(String code)	Returns a parametric datum from a code.
default PrimeMeridian	createPrimeMeridian(String code)	Returns a prime meridian from a code.
default TemporalDatum	createTemporalDatum(String code)	Returns a temporal datum from a code.
default VerticalDatum	createVerticalDatum(String code)	Returns a vertical datum from a code.

Methods inherited from interface org.opengis.referencing.AuthorityFactory

getAuthority, getAuthorityCodes, getDescriptionText, getDescriptionText

Methods inherited from interface org.opengis.util.Factory

getVendor

Method Details

createEllipsoid

@UML(identifier="createEllipsoid",
     specification=OGC_01009)
default Ellipsoid createEllipsoid(String code)
                           throws 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(String)

createPrimeMeridian

@UML(identifier="createPrimeMeridian",
     specification=OGC_01009)
default PrimeMeridian createPrimeMeridian(String code)
                                   throws 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(String)

createDatum

default Datum createDatum(String code)
                   throws FactoryException

Returns an arbitrary datum from a code.

If the datum type is known at compile time, then it is recommended to invoke the most precise method instead of this one. For example, it is usually better to invoke createGeodeticDatum(code) instead of createDatum(code) if the requested object is known to be a GeodeticDatum instance.

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(String)
• createVerticalDatum(String)
• createTemporalDatum(String)

createGeodeticDatum

@UML(identifier="createHorizontalDatum",
     specification=OGC_01009)
default GeodeticDatum createGeodeticDatum(String code)
                                   throws FactoryException

Returns a geodetic reference frame 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(String)
• createPrimeMeridian(String)
• CRSAuthorityFactory.createGeographicCRS(String)
• CRSAuthorityFactory.createProjectedCRS(String)

createVerticalDatum

@UML(identifier="createVerticalDatum",
     specification=OGC_01009)
default VerticalDatum createVerticalDatum(String code)
                                   throws FactoryException

Returns 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(String)

createTemporalDatum

default TemporalDatum createTemporalDatum(String code)
                                   throws FactoryException

Returns 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(String)

createParametricDatum

default ParametricDatum createParametricDatum(String code)
                                       throws FactoryException

Returns a parametric 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.createParametricCRS(String)

createEngineeringDatum

default EngineeringDatum createEngineeringDatum(String code)
                                         throws FactoryException

Returns 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(String)

createImageDatum

@Deprecated(since="3.1")
default ImageDatum createImageDatum(String code)
                             throws FactoryException

Deprecated.

ImageDatum is replaced by EngineeringDatum as of ISO 19111:2019.

Returns 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(String)

createObject

@Deprecated(since="3.1",
            forRemoval=true)
default IdentifiedObject createObject(String code)
                               throws FactoryException

Deprecated, for removal: This API element is subject to removal in a future version.

This method is ambiguous. Use createDatum(String) instead.

Returns an arbitrary object from a code.

Specified by:

createObject in interface AuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the object 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:

• createDatum(String)
• CRSAuthorityFactory.createCoordinateReferenceSystem(String)