All Superinterfaces:: AuthorityFactory, Factory

All Known Implementing Classes:: PseudoEpsgFactory

public interface CSAuthorityFactory extends AuthorityFactory

Creates coordinate 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 CoordinateSystem, delegate to createCoordinateSystem(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:

Method Summary

Modifier and Type

Method

Description

default CartesianCS

createCartesianCS(String code)

Returns a Cartesian coordinate system from a code.

default CoordinateSystem

createCoordinateSystem(String code)

Returns an arbitrary coordinate system from a code.

default CoordinateSystemAxis

createCoordinateSystemAxis(String code)

Returns a coordinate system axis from a code.

default CylindricalCS

createCylindricalCS(String code)

Returns a cylindrical coordinate system from a code.

default EllipsoidalCS

createEllipsoidalCS(String code)

Returns an ellipsoidal coordinate system from a code.

default IdentifiedObject

createObject(String code)

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

default ParametricCS

createParametricCS(String code)

Returns a parametric coordinate system from a code.

default PolarCS

createPolarCS(String code)

Returns a polar coordinate system from a code.

default SphericalCS

createSphericalCS(String code)

Returns a spherical coordinate system from a code.

default TimeCS

createTimeCS(String code)

Returns a temporal coordinate system from a code.

default javax.measure.Unit<?>

createUnit(String code)

Returns an unit of measurement from a code.

default VerticalCS

createVerticalCS(String code)

Returns a vertical coordinate 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
- createUnit
  
  @UML(identifier="CS_CoordinateSystemAuthorityFactory.createLinearUnit, createAngularUnit", specification=OGC_01009) default javax.measure.Unit<?> createUnit(String code) throws FactoryException
  
  Returns an unit of measurement from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the unit for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createCoordinateSystemAxis
  
  default CoordinateSystemAxis createCoordinateSystemAxis(String code) throws FactoryException
  
  Returns a coordinate system axis from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the axis for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createCoordinateSystem
  
  default CoordinateSystem createCoordinateSystem(String code) throws FactoryException
  
  Returns an arbitrary coordinate system from a code.
  If the coordinate 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 createCartesianCS(code) instead of createCoordinateSystem(code) if the requested object is known to be a CartesianCS instance.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createCartesianCS
  
  default CartesianCS createCartesianCS(String code) throws FactoryException
  
  Returns a Cartesian coordinate system from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createPolarCS
  
  default PolarCS createPolarCS(String code) throws FactoryException
  
  Returns a polar coordinate system from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createCylindricalCS
  
  default CylindricalCS createCylindricalCS(String code) throws FactoryException
  
  Returns a cylindrical coordinate system from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createSphericalCS
  
  default SphericalCS createSphericalCS(String code) throws FactoryException
  
  Returns a spherical coordinate system from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createEllipsoidalCS
  
  default EllipsoidalCS createEllipsoidalCS(String code) throws FactoryException
  
  Returns an ellipsoidal coordinate system from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createVerticalCS
  
  default VerticalCS createVerticalCS(String code) throws FactoryException
  
  Returns a vertical coordinate system from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createTimeCS
  
  default TimeCS createTimeCS(String code) throws FactoryException
  
  Returns a temporal coordinate system from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- createParametricCS
  
  default ParametricCS createParametricCS(String code) throws FactoryException
  
  Returns a parametric coordinate system from a code.
  
  Parameters:
  
  code - value allocated by authority.
  
  Returns:
  
  the coordinate system for the given code.
  
  Throws:
  
  NoSuchAuthorityCodeException - if the specified code was not found.
  
  FactoryException - if the object creation failed for some other reason.
- 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 createCoordinateSystem(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)
  
  CRSAuthorityFactory.createCoordinateReferenceSystem(String)

Interface CSAuthorityFactory

Default methods

Method Summary

Methods inherited from interface org.opengis.referencing.AuthorityFactory

Methods inherited from interface org.opengis.util.Factory

Method Details

createUnit

createCoordinateSystemAxis

createCoordinateSystem

createCartesianCS

createPolarCS

createCylindricalCS

createSphericalCS

createEllipsoidalCS

createVerticalCS

createTimeCS

createParametricCS

createObject