Module org.opengis.geoapi

Package org.opengis.referencing.crs

Interface CRSAuthorityFactory

All Superinterfaces:

AuthorityFactory, Factory

All Known Implementing Classes:

PseudoEpsgFactory

@UML(identifier="CS_CoordinateSystemAuthorityFactory",
     specification=OGC_01009)
public interface CRSAuthorityFactory
extends AuthorityFactory

Creates coordinate reference systems 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 CoordinateReferenceSystem, delegate to createCoordinateReferenceSystem(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
• DatumAuthorityFactory

Method Summary

Modifier and Type	Method	Description
default CompoundCRS	createCompoundCRS(String code)	Returns a 3D coordinate reference system from a code.
default CoordinateReferenceSystem	createCoordinateReferenceSystem(String code)	Returns an arbitrary coordinate reference system from a code.
default DerivedCRS	createDerivedCRS(String code)	Returns a derived coordinate reference system from a code.
default EngineeringCRS	createEngineeringCRS(String code)	Returns a engineering coordinate reference system from a code.
default GeocentricCRS	createGeocentricCRS(String code)	Deprecated. The GeocentricCRS type has been removed since ISO 19111:2007.
default GeodeticCRS	createGeodeticCRS(String code)	Returns a geodetic coordinate reference system from a code.
default GeographicCRS	createGeographicCRS(String code)	Returns a geographic coordinate reference system from a code.
default ImageCRS	createImageCRS(String code)	Deprecated. ImageCRS is replaced by EngineeringCRS 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 ParametricCRS	createParametricCRS(String code)	Returns a parametric coordinate reference system from a code.
default ProjectedCRS	createProjectedCRS(String code)	Returns a projected coordinate reference system from a code.
default TemporalCRS	createTemporalCRS(String code)	Returns a temporal coordinate reference system from a code.
default VerticalCRS	createVerticalCRS(String code)	Returns a vertical coordinate reference system 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

createCoordinateReferenceSystem

@UML(identifier="createHorizontalCoordinateSystem",
     specification=OGC_01009)
default CoordinateReferenceSystem createCoordinateReferenceSystem(String code)
                                                           throws FactoryException

Returns an arbitrary coordinate reference system from a code.

If the coordinate reference system 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 createGeographicCRS(code) instead of createCoordinateReferenceSystem(code) if the requested object is known to be a GeographicCRS instance.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system 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:

• createGeographicCRS(String)
• createProjectedCRS(String)
• createVerticalCRS(String)
• createTemporalCRS(String)
• createCompoundCRS(String)

createGeographicCRS

@UML(identifier="createGeographicCoordinateSystem",
     specification=OGC_01009)
default GeographicCRS createGeographicCRS(String code)
                                   throws FactoryException

Returns a geographic coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system 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:

• DatumAuthorityFactory.createGeodeticDatum(String)

createGeocentricCRS

@Deprecated(since="3.1")
default GeocentricCRS createGeocentricCRS(String code)
                                   throws FactoryException

Deprecated.

The GeocentricCRS type has been removed since ISO 19111:2007. Use createGeodeticCRS(String) instead.

Returns a geocentric coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

NoSuchAuthorityCodeException - if the specified code was not found.

FactoryException - if the object creation failed.

See Also:

• DatumAuthorityFactory.createGeodeticDatum(String)

createGeodeticCRS

default GeodeticCRS createGeodeticCRS(String code)
                               throws FactoryException

Returns a geodetic coordinate reference system from a code. A geodetic CRS can be geographic or geocentric.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

NoSuchAuthorityCodeException - if the specified code was not found.

FactoryException - if the object creation failed.

Since:

3.1

See Also:

• DatumAuthorityFactory.createGeodeticDatum(String)

createVerticalCRS

@UML(identifier="createVerticalCoordinateSystem",
     specification=OGC_01009)
default VerticalCRS createVerticalCRS(String code)
                               throws FactoryException

Returns a vertical coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system 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:

• DatumAuthorityFactory.createVerticalDatum(String)

createTemporalCRS

default TemporalCRS createTemporalCRS(String code)
                               throws FactoryException

Returns a temporal coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system 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:

• DatumAuthorityFactory.createTemporalDatum(String)

createParametricCRS

default ParametricCRS createParametricCRS(String code)
                                   throws FactoryException

Returns a parametric coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

NoSuchAuthorityCodeException - if the specified code was not found.

FactoryException - if the object creation failed for some other reason.

Since:

3.1

See Also:

• DatumAuthorityFactory.createParametricDatum(String)

createCompoundCRS

@UML(identifier="createCompoundCoordinateSystem",
     specification=OGC_01009)
default CompoundCRS createCompoundCRS(String code)
                               throws FactoryException

Returns a 3D coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

NoSuchAuthorityCodeException - if the specified code was not found.

FactoryException - if the object creation failed for some other reason.

createEngineeringCRS

default EngineeringCRS createEngineeringCRS(String code)
                                     throws FactoryException

Returns a engineering coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

NoSuchAuthorityCodeException - if the specified code was not found.

FactoryException - if the object creation failed for some other reason.

createImageCRS

@Deprecated(since="3.1")
default ImageCRS createImageCRS(String code)
                         throws FactoryException

Deprecated.

ImageCRS is replaced by EngineeringCRS as of ISO 19111:2019.

Returns a image coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

NoSuchAuthorityCodeException - if the specified code was not found.

FactoryException - if the object creation failed for some other reason.

createDerivedCRS

default DerivedCRS createDerivedCRS(String code)
                             throws FactoryException

Returns a derived coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

NoSuchAuthorityCodeException - if the specified code was not found.

FactoryException - if the object creation failed for some other reason.

createProjectedCRS

@UML(identifier="createProjectedCoordinateSystem",
     specification=OGC_01009)
default ProjectedCRS createProjectedCRS(String code)
                                 throws FactoryException

Returns a projected coordinate reference system from a code.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system 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:

• DatumAuthorityFactory.createGeodeticDatum(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 createCoordinateReferenceSystem(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:

• DatumAuthorityFactory.createDatum(String)
• createCoordinateReferenceSystem(String)