Module org.apache.sis.referencing

Package org.apache.sis.referencing.factory

Class GeodeticAuthorityFactory

Object

AbstractFactory

GeodeticAuthorityFactory

All Implemented Interfaces:

Authority­Factory, Factory

Direct Known Subclasses:

Common­Authority­Factory, Concurrent­Authority­Factory, EPSGData­Access, Multi­Authorities­Factory, WKTDictionary

public abstract class GeodeticAuthorityFactory
extends AbstractFactory
implements AuthorityFactory

Creates geodetic objects from codes defined by an authority. An authority is an organization that maintains definitions of authority codes. An authority code is a compact string defined by an authority to reference a particular spatial reference object. A frequently used set of authority codes is the EPSG geodetic dataset, a database of coordinate systems and other spatial referencing objects where each object has a code number ID.

Example: the EPSG code for a World Geodetic System 1984 (WGS84) coordinate reference system with latitude and longitude axes is "4326".

This class defines a default implementation for most methods defined in the Datum­Authority­Factory, CSAuthority­Factory and CRSAuthority­Factory interfaces. However, those interfaces do not appear in the implements clause of this class declaration. This is up to subclasses to decide which interfaces they declare to implement.

The default implementation for all create­Foo(String) methods ultimately invokes create­Object(String), which may be the only method that a subclass need to override. However, other methods may be overridden as well for better performances.

Since:

0.7

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Geodetic­Authority­Factory()	Creates a new authority factory for geodetic objects.

Method Summary

Modifier and Type	Method	Description
Cartesian­CS	create­Cartesian­CS(String code)	Creates a 2- or 3-dimensional Cartesian coordinate system made of straight orthogonal axes.
Compound­CRS	create­Compound­CRS(String code)	Creates a CRS describing the position of points through two or more independent coordinate reference systems.
Coordinate­Operation	create­Coordinate­Operation(String code)	Creates an operation for transforming coordinates in the source CRS to coordinates in the target CRS.
Coordinate­Reference­System	create­Coordinate­Reference­System(String code)	Creates an arbitrary coordinate reference system from a code.
Coordinate­System	create­Coordinate­System(String code)	Creates an arbitrary coordinate system from a code.
Coordinate­System­Axis	create­Coordinate­System­Axis(String code)	Creates a coordinate system axis with name, direction, unit and range of values.
Cylindrical­CS	create­Cylindrical­CS(String code)	Creates a 3-dimensional coordinate system made of a polar coordinate system extended by a straight perpendicular axis.
Datum	create­Datum(String code)	Creates an arbitrary datum from a code.
Derived­CRS	create­Derived­CRS(String code)	Creates a CRS that is defined by its coordinate conversion from another CRS (not by a datum).
Ellipsoid	create­Ellipsoid(String code)	Creates a geometric figure that can be used to describe the approximate shape of the earth.
Ellipsoidal­CS	create­Ellipsoidal­CS(String code)	Creates a 2- or 3-dimensional coordinate system for geodetic latitude and longitude, sometimes with ellipsoidal height.
Engineering­CRS	create­Engineering­CRS(String code)	Creates a 1-, 2- or 3-dimensional contextually local coordinate reference system.
Engineering­Datum	create­Engineering­Datum(String code)	Creates a datum defining the origin of an engineering coordinate reference system.
Extent	create­Extent(String code)	Creates information about spatial, vertical, and temporal extent (usually a domain of validity) from a code.
Set<Coordinate­Operation>	create­From­Coordinate­Reference­System­Codes(String source­CRS, String target­CRS)	Creates operations from source and target coordinate reference system codes.
Geocentric­CRS	create­Geocentric­CRS(String code)	Creates a 3-dimensional coordinate reference system with the origin at the approximate centre of mass of the earth.
Geodetic­Datum	create­Geodetic­Datum(String code)	Creates a datum defining the location and orientation of an ellipsoid that approximates the shape of the earth.
Geographic­CRS	create­Geographic­CRS(String code)	Creates a 2- or 3-dimensional coordinate reference system based on an ellipsoidal approximation of the geoid.
Image­CRS	create­Image­CRS(String code)	Creates a 2-dimensional engineering coordinate reference system applied to locations in images.
Image­Datum	create­Image­Datum(String code)	Creates a datum defining the origin of an image coordinate reference system.
abstract Identified­Object	create­Object(String code)	Returns an arbitrary object from a code.
Operation­Method	create­Operation­Method(String code)	Creates a description of the algorithm and parameters used to perform a coordinate operation.
Parameter­Descriptor<?>	create­Parameter­Descriptor(String code)	Creates a definition of a single parameter used by an operation method.
Default­Parametric­CRS	create­Parametric­CRS(String code)	Creates a 1-dimensional parametric coordinate reference system.
Default­Parametric­CS	create­Parametric­CS(String code)	Creates a 1-dimensional parametric coordinate system.
Default­Parametric­Datum	create­Parametric­Datum(String code)	Creates a datum defining the origin of a parametric coordinate reference system.
Polar­CS	create­Polar­CS(String code)	Creates a 2-dimensional coordinate system for coordinates represented by a distance from the origin and an angle from a fixed direction.
Prime­Meridian	create­Prime­Meridian(String code)	Creates a prime meridian defining the origin from which longitude values are determined.
Projected­CRS	create­Projected­CRS(String code)	Creates a 2-dimensional coordinate reference system used to approximate the shape of the earth on a planar surface.
Spherical­CS	create­Spherical­CS(String code)	Creates a 3-dimensional coordinate system with one distance measured from the origin and two angular coordinates.
Temporal­CRS	create­Temporal­CRS(String code)	Creates a 1-dimensional coordinate reference system used for the recording of time.
Temporal­Datum	create­Temporal­Datum(String code)	Creates a datum defining the origin of a temporal coordinate reference system.
Time­CS	create­Time­CS(String code)	Creates a 1-dimensional coordinate system for time elapsed in the specified time units from a specified time origin.
Unit<?>	create­Unit(String code)	Creates an unit of measurement from a code.
Vertical­CRS	create­Vertical­CRS(String code)	Creates a 1-dimensional coordinate reference system used for recording heights or depths.
Vertical­CS	create­Vertical­CS(String code)	Creates a 1-dimensional coordinate system for heights or depths of points.
Vertical­Datum	create­Vertical­Datum(String code)	Creates a datum identifying a particular reference level surface used as a zero-height surface.
abstract Citation	get­Authority()	Returns the database or specification that defines the codes recognized by this factory.
Set<String>	get­Code­Spaces()	Returns all namespaces recognized by this factory.
International­String	get­Description­Text(String code)	Returns a description of the object corresponding to a code.
Identified­Object­Finder	new­Identified­Object­Finder()	Creates a finder which can be used for looking up unidentified objects.
String	to­String()	Returns a string representation of this factory for debugging purpose only.
protected final String	trim­Namespace(String code)	Trims the namespace, if present.

Methods inherited from class AbstractFactory

get­Vendor

Methods inherited from class Object

clone, equals, finalize, get­Class, hash­Code, notify, notify­All, wait, wait, wait

Methods inherited from interface AuthorityFactory

get­Authority­Codes

Methods inherited from interface Factory

get­Vendor

Constructor Details

GeodeticAuthorityFactory

protected GeodeticAuthorityFactory()

Creates a new authority factory for geodetic objects.

Method Details

getAuthority

public abstract Citation getAuthority()

Returns the database or specification that defines the codes recognized by this factory. This method may return null if it cannot obtain this information, for example because the connection to a database is not available.

Example

A factory that create coordinate reference system objects from EPSG codes could return a citation like below:

   Citation
   ├─ Title ……………………………………………………… EPSG Geodetic Parameter Dataset
   ├─ Identifier ………………………………………… EPSG
   ├─ Online resource (1 of 2)
   │  ├─ Linkage ………………………………………… https://epsg.org/
   │  └─ Function ……………………………………… Browse
   └─ Online resource (2 of 2)
      ├─ Linkage ………………………………………… jdbc:derby:/my/path/to/SIS_DATA/Databases/SpatialMetadata
      ├─ Description ……………………………… EPSG dataset version 9.1 on “Apache Derby Embedded JDBC Driver” version 10.14.
      └─ Function ……………………………………… Connection

The online resource description with a “Connection” function is a SIS extension.

Specified by:

get­Authority in interface Authority­Factory

Returns:

the organization responsible for definition of the database, or null if unknown.

See Also:

• Abstract­Factory.get­Vendor()

getCodeSpaces

public Set<String> getCodeSpaces()

Returns all namespaces recognized by this factory. Those namespaces can appear before codes in calls to create­Foo(String) methods, for example "EPSG" in "EPSG:4326". Namespaces are case-insensitive.

The namespaces are closely related to the authority. Often the namespace is the authority identifier, but not always.

Examples

• The EPSGFactory authority identifier is "EPSG" and its get­Code­Spaces() method returns a set containing "EPSG". So in this example, authority and namespace match. That namespace value means that EPSGFactory.create­Foo(String) methods accept both "EPSG:4326" (case-insensitive) and "4326" codes as argument.
• The EPSGData­Access authority identifier is "EPSG" but its get­Code­Spaces() method returns an empty set. This means that despite the EPSG authority, EPSGData­Access.create­Foo(String) methods accept only codes like "4326" without "EPSG:" prefix (the reason is that EPSGData­Access is not expected to be used directly).
• The Common­Authority­Factory authority identifiers are ISO 19128 and OGC 06-042 (the WMS specification) but its get­Code­Spaces() method returns a set containing "CRS", "AUTO" and "AUTO2". While ISO 19128 is defined as the first authority, the namespace is actually defined by OGC.

Default implementation

The default implementation infers the namespace from the authority. Subclasses can override this method, but the set should always contain the same elements during all factory lifetime.

Returns:

the namespaces recognized by this factory, or an empty set if none.

getDescriptionText

public InternationalString getDescriptionText(String code)
                                       throws FactoryException

Returns a description of the object corresponding to a code. The description can be used for example in a combo box in a graphical user interface.

Default implementation

The default implementation invokes create­Object(String) for the given code and returns the object name. This may be costly since it involves a full object creation. Subclasses are encouraged to provide a more efficient implementation if they can.

Specified by:

get­Description­Text in interface Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

a description of the object, or null if the object corresponding to the specified code has no description.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if an error occurred while fetching the description.

createObject

public abstract IdentifiedObject createObject(String code)
                                       throws NoSuchAuthorityCodeException,
FactoryException

Returns an arbitrary object from a code. The returned object will typically be an instance of Datum, Coordinate­System, Coordinate­Reference­System or Coordinate­Operation. This method may be used when the type of the object to create is unknown. But it is recommended to invoke the most specific create­Foo(String) method when the desired type is known, both for performance reason and for avoiding ambiguity.

Note for subclasses

In default Geodetic­Authority­Factory implementation, all create­Foo(String) methods ultimately delegate to this create­Object(String) method and verify if the created object is of the desired type. Overriding this method is sufficient for supporting the more specific create­Foo(String) methods, but subclasses are encouraged to override the latter for efficiency.

Specified by:

create­Object in interface Authority­Factory

Parameters:

code - value allocated by authority.

Returns:

the object for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Abstract­Identified­Object

createCoordinateReferenceSystem

public CoordinateReferenceSystem createCoordinateReferenceSystem(String code)
                                                          throws NoSuchAuthorityCodeException,
FactoryException

Creates an arbitrary coordinate reference system from a code. The returned object will typically be an instance of Geographic­CRS, Projected­CRS, Vertical­CRS or Compound­CRS. If the coordinate reference system type is known at compile time, it is recommended to invoke the most precise method instead of this one (for example create­Geographic­CRS(String) instead of create­Coordinate­Reference­System(code) if the caller know he is asking for a geographic coordinate reference system).

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. Two frequently used authorities are "CRS" and "EPSG", which include the following codes:

Authority codes examples

Code	Type	Description
CRS:84	Geographic	Like EPSG:4326 except for (longitude, latitude) axis order
EPSG:4326	Geographic	World Geodetic System 1984
EPSG:4979	Geographic 3D	World Geodetic System 1984
EPSG:4978	Geocentric	World Geodetic System 1984
EPSG:3395	Projected	WGS 84 / World Mercator
EPSG:5714	Vertical	Mean Sea Level height
EPSG:6349	Compound	NAD83(2011) + NAVD88 height
EPSG:5800	Engineering	Astra Minas Grid

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Abstract­CRS
• CRS.for­Code(String)

createGeographicCRS

public GeographicCRS createGeographicCRS(String code)
                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates a 2- or 3-dimensional coordinate reference system based on an ellipsoidal approximation of the geoid. This provides an accurate representation of the geometry of geographic features for a large portion of the earth's surface.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. Two frequently used authorities are "CRS" and "EPSG", which include the following codes:

Authority codes examples

Code	Type	Description
CRS:27	Geographic	Like EPSG:4267 except for (longitude, latitude) axis order
CRS:83	Geographic	Like EPSG:4269 except for (longitude, latitude) axis order
CRS:84	Geographic	Like EPSG:4326 except for (longitude, latitude) axis order
EPSG:4322	Geographic	World Geodetic System 1972
EPSG:4985	Geographic 3D	World Geodetic System 1972
EPSG:4326	Geographic	World Geodetic System 1984
EPSG:4979	Geographic 3D	World Geodetic System 1984
EPSG:4267	Geographic	North American Datum 1927
EPSG:4269	Geographic	North American Datum 1983
EPSG:4230	Geographic	European Datum 1950
EPSG:4258	Geographic	European Terrestrial Reference Frame 1989
EPSG:4937	Geographic 3D	European Terrestrial Reference Frame 1989

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Geographic­CRS
• Common­CRS.geographic()
• Common­CRS.geographic3D()

createGeocentricCRS

public GeocentricCRS createGeocentricCRS(String code)
                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates a 3-dimensional coordinate reference system with the origin at the approximate centre of mass of the earth. A geocentric CRS deals with the earth's curvature by taking a 3-dimensional spatial view, which obviates the need to model the earth's curvature.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:4936	European Terrestrial Reference Frame 1989
EPSG:4978	World Geodetic System 1984
EPSG:4984	World Geodetic System 1972

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed.

See Also:

• Default­Geocentric­CRS
• Common­CRS.geocentric()

createProjectedCRS

public ProjectedCRS createProjectedCRS(String code)
                                throws NoSuchAuthorityCodeException,
FactoryException

Creates a 2-dimensional coordinate reference system used to approximate the shape of the earth on a planar surface. It is done in such a way that the distortion that is inherent to the approximation is carefully controlled and known. Distortion correction is commonly applied to calculated bearings and distances to produce values that are a close match to actual field values.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which contains more than 4000 codes for projected CRS. Some of them are:

Authority codes examples

Code	Description
EPSG:3034	ETRS89 / Lambert Conic Conformal Europe
EPSG:3395	WGS 84 / World Mercator
EPSG:6350	NAD83(2011) / Conus Albers Equal Area

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Projected­CRS

createVerticalCRS

public VerticalCRS createVerticalCRS(String code)
                              throws NoSuchAuthorityCodeException,
FactoryException

Creates a 1-dimensional coordinate reference system used for recording heights or depths. Vertical CRSs make use of the direction of gravity to define the concept of height or depth, but the relationship with gravity may not be straightforward.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:5715	Mean Sea Level depth
EPSG:5714	Mean Sea Level height

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Vertical­CRS
• Common­CRS.Vertical.crs()

createTemporalCRS

public TemporalCRS createTemporalCRS(String code)
                              throws NoSuchAuthorityCodeException,
FactoryException

Creates a 1-dimensional coordinate reference system used for the recording of time.

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Temporal­CRS
• Common­CRS.Temporal.crs()

createParametricCRS

public DefaultParametricCRS createParametricCRS(String code)
                                         throws NoSuchAuthorityCodeException,
FactoryException

Creates a 1-dimensional parametric coordinate reference system.

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Warning: in a future SIS version, the return type may be changed to org.opengis.referencing.crs.Parametric­CRS. This change is pending GeoAPI revision.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Parametric­CRS

createCompoundCRS

public CompoundCRS createCompoundCRS(String code)
                              throws NoSuchAuthorityCodeException,
FactoryException

Creates a CRS describing the position of points through two or more independent coordinate reference systems.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:6349	NAD83(2011) + NAVD88 height
EPSG:7423	ETRS89 + EVRF2007 height

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Compound­CRS

createDerivedCRS

public DerivedCRS createDerivedCRS(String code)
                            throws NoSuchAuthorityCodeException,
FactoryException

Creates a CRS that is defined by its coordinate conversion from another CRS (not by a datum). Derived­CRS cannot be Projected­CRS themselves, but may be derived from a projected CRS.

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Derived­CRS

createEngineeringCRS

public EngineeringCRS createEngineeringCRS(String code)
                                    throws NoSuchAuthorityCodeException,
FactoryException

Creates a 1-, 2- or 3-dimensional contextually local coordinate reference system.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:5800	Astra Minas Grid

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Engineering­CRS

createImageCRS

public ImageCRS createImageCRS(String code)
                        throws NoSuchAuthorityCodeException,
FactoryException

Creates a 2-dimensional engineering coordinate reference system applied to locations in images. Image coordinate reference systems are treated as a separate sub-type because a separate user community exists for images with its own terms of reference.

Default implementation

The default implementation delegates to create­Coordinate­Reference­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Image­CRS

createDatum

public Datum createDatum(String code)
                  throws NoSuchAuthorityCodeException,
FactoryException

Creates an arbitrary datum from a code. The returned object will typically be an instance of Geodetic­Datum, Vertical­Datum or Temporal­Datum. If the datum is known at compile time, it is recommended to invoke the most precise method instead of this one.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which contains hundred of datum. Some of them are:

Authority codes examples

Code	Type	Description
EPSG:6326	Geodetic	World Geodetic System 1984
EPSG:6322	Geodetic	World Geodetic System 1972
EPSG:1027	Vertical	EGM2008 geoid
EPSG:5100	Vertical	Mean Sea Level
EPSG:9315	Engineering	Seismic bin grid datum

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Abstract­Datum

createGeodeticDatum

public GeodeticDatum createGeodeticDatum(String code)
                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates a datum defining the location and orientation of an ellipsoid that approximates the shape of the earth. Geodetic datum are used together with ellipsoidal coordinate system, and also with Cartesian coordinate system centered in the ellipsoid (or sphere).

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which contains hundred of datum. Some of them are:

Authority codes examples

Code	Description
EPSG:6326	World Geodetic System 1984
EPSG:6322	World Geodetic System 1972
EPSG:6269	North American Datum 1983
EPSG:6258	European Terrestrial Reference System 1989

Default implementation

The default implementation delegates to create­Datum(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Geodetic­Datum
• Common­CRS.datum()

createVerticalDatum

public VerticalDatum createVerticalDatum(String code)
                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates a datum identifying a particular reference level surface used as a zero-height surface. There are several types of vertical datums, and each may place constraints on the axis with which it is combined to create a vertical CRS.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:5100	Mean Sea Level
EPSG:1027	EGM2008 geoid
EPSG:1131	Japanese Geodetic Datum 2011 (vertical)
EPSG:5215	European Vertical Reference Frame 2007

Default implementation

The default implementation delegates to create­Datum(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Vertical­Datum
• Common­CRS.Vertical.datum()

createTemporalDatum

public TemporalDatum createTemporalDatum(String code)
                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates a datum defining the origin of a temporal coordinate reference system.

Default implementation

The default implementation delegates to create­Datum(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Temporal­Datum
• Common­CRS.Temporal.datum()

createParametricDatum

public DefaultParametricDatum createParametricDatum(String code)
                                             throws NoSuchAuthorityCodeException,
FactoryException

Creates a datum defining the origin of a parametric coordinate reference system.

Default implementation

The default implementation delegates to create­Datum(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Warning: in a future SIS version, the return type may be changed to org.opengis.referencing.datum.Parametric­Datum. This change is pending GeoAPI revision.

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Parametric­Datum

createEngineeringDatum

public EngineeringDatum createEngineeringDatum(String code)
                                        throws NoSuchAuthorityCodeException,
FactoryException

Creates a datum defining the origin of an engineering coordinate reference system. An engineering datum is used in a region around that origin. This origin can be fixed with respect to the earth or be a defined point on a moving vehicle.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:9315	Seismic bin grid datum
EPSG:9300	Astra Minas

Default implementation

The default implementation delegates to create­Datum(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Engineering­Datum

createImageDatum

public ImageDatum createImageDatum(String code)
                            throws NoSuchAuthorityCodeException,
FactoryException

Creates a datum defining the origin of an image coordinate reference system. An image datum is used in a local context only. For an image datum, the anchor point is usually either the centre of the image or the corner of the image.

Default implementation

The default implementation delegates to create­Datum(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Image­Datum

createEllipsoid

public Ellipsoid createEllipsoid(String code)
                          throws NoSuchAuthorityCodeException,
FactoryException

Creates a geometric figure that can be used to describe the approximate shape of the earth. In mathematical terms, it is a surface formed by the rotation of an ellipse about its minor axis.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:7030	WGS 84
EPSG:7034	Clarke 1880
EPSG:7048	GRS 1980 Authalic Sphere

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the ellipsoid for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Ellipsoid
• Common­CRS.ellipsoid()

createPrimeMeridian

public PrimeMeridian createPrimeMeridian(String code)
                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates a prime meridian defining the origin from which longitude values are determined.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:8901	Greenwich
EPSG:8903	Paris
EPSG:8904	Bogota
EPSG:8905	Madrid
EPSG:8906	Rome

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the prime meridian for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Prime­Meridian
• Common­CRS.prime­Meridian()

createExtent

public Extent createExtent(String code)
                    throws NoSuchAuthorityCodeException,
FactoryException

Creates information about spatial, vertical, and temporal extent (usually a domain of validity) from a code.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:1262	World
EPSG:3391	World - between 80°S and 84°N

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the extent for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Extent

createCoordinateSystem

public CoordinateSystem createCoordinateSystem(String code)
                                        throws NoSuchAuthorityCodeException,
FactoryException

Creates an arbitrary coordinate system from a code. The returned object will typically be an instance of Ellipsoidal­CS, Cartesian­CS, Vertical­CS or Time­CS. If the coordinate system is known at compile time, it is recommended to invoke the most precise method instead of this one.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Type	Axes	Orientations	Unit
EPSG:4496	Cartesian 2D CS	easting, northing (E,N)	east, north	metre
EPSG:6422	Ellipsoidal 2D CS	latitude, longitude	north, east	degree
EPSG:6423	Ellipsoidal 3D CS	latitude, longitude, ellipsoidal height	north, east, up	degree, degree, metre
EPSG:6404	Spherical 3D CS	latitude, longitude, radius	north, east, up	degree, degree, metre
EPSG:6499	Vertical CS	height (H)	up	metre

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Abstract­CS
• Coordinate­Systems.get­Epsg­Code(Unit, Axis­Direction...)

createEllipsoidalCS

public EllipsoidalCS createEllipsoidalCS(String code)
                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates a 2- or 3-dimensional coordinate system for geodetic latitude and longitude, sometimes with ellipsoidal height.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Axes	Orientations	Unit
EPSG:6422	latitude, longitude	north, east	degree
EPSG:6424	longitude, latitude	east, north	degree
EPSG:6429	longitude, latitude	east, north	radian
EPSG:6423	latitude, longitude, ellipsoidal height	north, east, up	degree, degree, metre

Default implementation

The default implementation delegates to create­Coordinate­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Ellipsoidal­CS

createVerticalCS

public VerticalCS createVerticalCS(String code)
                            throws NoSuchAuthorityCodeException,
FactoryException

Creates a 1-dimensional coordinate system for heights or depths of points.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Axes	Orientations	Unit
EPSG:6498	depth (D)	down	metre
EPSG:6499	height (H)	up	metre

Default implementation

The default implementation delegates to create­Coordinate­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Vertical­CS

createTimeCS

public TimeCS createTimeCS(String code)
                    throws NoSuchAuthorityCodeException,
FactoryException

Creates a 1-dimensional coordinate system for time elapsed in the specified time units from a specified time origin.

Default implementation

The default implementation delegates to create­Coordinate­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Time­CS

createParametricCS

public DefaultParametricCS createParametricCS(String code)
                                       throws NoSuchAuthorityCodeException,
FactoryException

Creates a 1-dimensional parametric coordinate system.

Default implementation

The default implementation delegates to create­Coordinate­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Warning: in a future SIS version, the return type may be changed to org.opengis.referencing.cs.Parametric­CS. This change is pending GeoAPI revision.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Parametric­CS

createCartesianCS

public CartesianCS createCartesianCS(String code)
                              throws NoSuchAuthorityCodeException,
FactoryException

Creates a 2- or 3-dimensional Cartesian coordinate system made of straight orthogonal axes. All axes shall have the same linear unit of measure.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Axes	Orientations	Unit
EPSG:4406	easting, northing (E,N)	east, north	kilometre
EPSG:4496	easting, northing (E,N)	east, north	metre
EPSG:4500	northing, easting (N,E)	north, east	metre
EPSG:4491	westing, northing (W,N)	west, north	metre

Default implementation

The default implementation delegates to create­Coordinate­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Cartesian­CS

createSphericalCS

public SphericalCS createSphericalCS(String code)
                              throws NoSuchAuthorityCodeException,
FactoryException

Creates a 3-dimensional coordinate system with one distance measured from the origin and two angular coordinates. Not to be confused with an ellipsoidal coordinate system based on an ellipsoid "degenerated" into a sphere.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Axes	Orientations	Unit
EPSG:6404	latitude, longitude, radius	north, east, up	degree, degree, metre

Default implementation

The default implementation delegates to create­Coordinate­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Spherical­CS

createCylindricalCS

public CylindricalCS createCylindricalCS(String code)
                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates a 3-dimensional coordinate system made of a polar coordinate system extended by a straight perpendicular axis.

Default implementation

The default implementation delegates to create­Coordinate­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Cylindrical­CS

createPolarCS

public PolarCS createPolarCS(String code)
                      throws NoSuchAuthorityCodeException,
FactoryException

Creates a 2-dimensional coordinate system for coordinates represented by a distance from the origin and an angle from a fixed direction.

Default implementation

The default implementation delegates to create­Coordinate­System(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Polar­CS

createCoordinateSystemAxis

public CoordinateSystemAxis createCoordinateSystemAxis(String code)
                                                throws NoSuchAuthorityCodeException,
FactoryException

Creates a coordinate system axis with name, direction, unit and range of values.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description	Unit
EPSG:106	Latitude (φ)	degree
EPSG:107	Longitude (λ)	degree
EPSG:1	Easting (E)	metre
EPSG:2	Northing (N)	metre

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the axis for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Coordinate­System­Axis

createUnit

public Unit<?> createUnit(String code)
                   throws NoSuchAuthorityCodeException,
FactoryException

Creates an unit of measurement from a code.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:9002	decimal degree
EPSG:9001	metre
EPSG:9030	kilometre
EPSG:1040	second
EPSG:1029	year

See Units.value­Of­EPSG(int) for a more complete list of codes.

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the unit of measurement for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Units.value­Of­EPSG(int)

createParameterDescriptor

public ParameterDescriptor<?> createParameterDescriptor(String code)
                                                 throws NoSuchAuthorityCodeException,
FactoryException

Creates a definition of a single parameter used by an operation method.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:8801	Latitude of natural origin
EPSG:8802	Longitude of natural origin
EPSG:8805	Scale factor at natural origin
EPSG:8806	False easting
EPSG:8807	False northing

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the parameter descriptor for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Parameter­Descriptor
• Apache SIS™ Coordinate Operation Methods

createOperationMethod

public OperationMethod createOperationMethod(String code)
                                      throws NoSuchAuthorityCodeException,
FactoryException

Creates a description of the algorithm and parameters used to perform a coordinate operation. An Operation­Method is a kind of metadata: it does not perform any coordinate operation (e.g. map projection) by itself, but tells us what is needed in order to perform such operation.

Available methods depend both on the set declared by the authority and on the list of methods implemented in Apache SIS. In order to be supported, an operation method must have its formulas coded in the Java programming language. See Math­Transform­Provider for more information.

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the operation method for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Default­Operation­Method
• Apache SIS™ Coordinate Operation Methods

createCoordinateOperation

public CoordinateOperation createCoordinateOperation(String code)
                                              throws NoSuchAuthorityCodeException,
FactoryException

Creates an operation for transforming coordinates in the source CRS to coordinates in the target CRS. Coordinate operations contain a math transform, which does the actual work of transforming coordinates.

Examples

The set of available codes depends on the defining authority and the Geodetic­Authority­Factory subclass in use. A frequently used authority is "EPSG", which includes the following codes:

Authority codes examples

Code	Description
EPSG:1133	ED50 to WGS 84 (1)
EPSG:1241	NAD27 to NAD83 (1)
EPSG:1173	NAD27 to WGS 84 (4)
EPSG:6326	NAD83(2011) to NAVD88 height (1)

Default implementation

The default implementation delegates to create­Object(String) and casts the result. If the result cannot be casted, then a No­Such­Authority­Code­Exception is thrown.

Parameters:

code - value allocated by authority.

Returns:

the operation for the given code.

Throws:

No­Such­Authority­Code­Exception - if the specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

See Also:

• Abstract­Coordinate­Operation

createFromCoordinateReferenceSystemCodes

public Set<CoordinateOperation> createFromCoordinateReferenceSystemCodes(String sourceCRS,
 String targetCRS)
                                                                  throws NoSuchAuthorityCodeException,
FactoryException

Creates operations from source and target coordinate reference system codes. This method should only extract the information explicitly declared in a database like EPSG. This method should not attempt to infer by itself operations that are not explicitly recorded in the database.

Default implementation

The default implementation returns an empty set.

Parameters:

source­CRS - coded value of source coordinate reference system.

target­CRS - coded value of target coordinate reference system.

Returns:

the operations from source­CRS to target­CRS.

Throws:

No­Such­Authority­Code­Exception - if a specified code was not found.

Factory­Exception - if the object creation failed for some other reason.

newIdentifiedObjectFinder

public IdentifiedObjectFinder newIdentifiedObjectFinder()
                                                 throws FactoryException

Creates a finder which can be used for looking up unidentified objects. The finder tries to fetch a fully identified object from an incomplete one, for example from an object without "ID[…]" or "AUTHORITY[…]" element in Well Known Text.

Returns:

a finder to use for looking up unidentified objects.

Throws:

Factory­Exception - if the finder cannot be created.

See Also:

• Identified­Objects.new­Finder(String)

trimNamespace

protected final String trimNamespace(String code)

Trims the namespace, if present. For example if this factory is an EPSG authority factory and the specified code start with the "EPSG:" prefix, then the prefix is removed. Otherwise, the string is returned unchanged (except for leading and trailing spaces).

Parameters:

code - the code to trim.

Returns:

the code with the namespace part removed if that part matched one of the values given by get­Code­Spaces().

Since:

0.8

toString

public String toString()

Returns a string representation of this factory for debugging purpose only. The string returned by this method may change in any future SIS version.

Overrides:

to­String in class Object

Returns:

a string representation for debugging purpose.