Class GeodeticObjectFactory

Object

AbstractFactory

GeodeticObjectFactory

All Implemented Interfaces:

Parser, CRSFactory, CSFactory, Datum­Factory, Object­Factory, Factory

public class GeodeticObjectFactory
extends AbstractFactory
implements CRSFactory, CSFactory, DatumFactory, Parser

Creates Coordinate Reference System (CRS) implementations, with their Coordinate System (CS) and Datum components. This factory serves two purposes:

• For users, allows the creation of complex objects that cannot be created by the authority factories, without explicit dependency to Apache SIS (when using the GeoAPI interfaces implemented by this class).
• For providers, allows inversion of control by overriding methods in this class, then specifying the customized instance to other services that consume CRSFactory (for example authority factories or WKT parsers).

This Geodetic­Object­Factory class is not easy to use directly. Users are encouraged to use an authority factory instead (or the CRS.for­Code(String) convenience method) when the CRS object to construct can be identified by a code in the namespace of an authority (typically EPSG).

Object properties

Most factory methods expect a Map<String,?> argument, often followed by explicit arguments. Unless otherwise noticed, information provided in the properties map are considered ignorable metadata while information provided in explicit arguments have an impact on coordinate transformation results.

The following table lists the keys recognized by the Geodetic­Object­Factory default implementation, together with the type of values associated to those keys. A value for the "name" key is mandatory for all objects, while all other properties are optional. Geodetic­Object­Factory methods ignore all unknown properties.

Recognized properties (non exhaustive list)

Property name	Value type	Returned by
"name"	Identifier or String	AbstractIdentifiedObject.getName()
"authority"	String or Citation	ImmutableIdentifier.getAuthority() on the name
"code"	String	ImmutableIdentifier.getCode() on the name
"codespace"	String	ImmutableIdentifier.getCodeSpace() on the name
"version"	String	ImmutableIdentifier.getVersion() on the name
"description"	String	ImmutableIdentifier.getDescription() on the name
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	Identifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"domains"	DefaultObjectDomain (optionally as array)	AbstractIdentifiedObject.getDomains()
"domainOfValidity"	Extent	DefaultObjectDomain.getDomainOfValidity()
"scope"	String or International­String	DefaultObjectDomain.getScope()
"anchorPoint"	InternationalString or String	AbstractDatum.getAnchorDefinition()
	Temporal	AbstractDatum.getAnchorEpoch()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()
"deprecated"	Boolean	AbstractIdentifiedObject.isDeprecated()
"locale"	Locale	(none)

Localization

All localizable attributes like "remarks" may have a language and country code suffix. For example, the "remarks_fr" property stands for remarks in French and the "remarks_fr_CA" property stands for remarks in French Canadian. They are convenience properties for building the International­String value.

The "locale" property applies only in case of exception for formatting the error message, and is used only on a best effort basis. The locale is discarded after successful construction since localizations are applied by the International­String.to­String(Locale) method.

Since:

0.6

Constructor Summary

Constructors

Constructor	Description
Geodetic­Object­Factory()	Constructs a factory with no default properties.
Geodetic­Object­Factory(Map<String,?> properties)	Constructs a factory with the given default properties.

Method Summary

Modifier and Type	Method	Description
protected Map<String,?>	complete(Map<String,?> properties)	Returns the union of the given properties map with the default properties given at construction time.
Affine­CS	create­Affine­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1)	Creates a two-dimensional affine coordinate system from the given pair of axis.
Affine­CS	create­Affine­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1, Coordinate­System­Axis axis2)	Creates a three-dimensional affine coordinate system from the given set of axis.
Cartesian­CS	create­Cartesian­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1)	Creates a two-dimensional Cartesian coordinate system from the given pair of axis.
Cartesian­CS	create­Cartesian­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1, Coordinate­System­Axis axis2)	Creates a three-dimensional Cartesian coordinate system from the given set of axis.
Compound­CRS	create­Compound­CRS(Map<String,?> properties, Coordinate­Reference­System... components)	Creates a compound coordinate reference system from an ordered list of CRS components.
Coordinate­System­Axis	create­Coordinate­System­Axis(Map<String,?> properties, String abbreviation, Axis­Direction direction, Unit<?> unit)	Creates a coordinate system axis from an abbreviation and a unit.
Cylindrical­CS	create­Cylindrical­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1, Coordinate­System­Axis axis2)	Creates a cylindrical coordinate system from the given set of axis.
<D extends Datum> Default­Datum­Ensemble<D>	create­Datum­Ensemble(Map<String,?> properties, Collection<? extends D> members, Positional­Accuracy accuracy)	Creates a datum ensemble from a collection of members and an ensemble accuracy.
Derived­CRS	create­Derived­CRS(Map<String,?> properties, Coordinate­Reference­System base­CRS, Conversion base­To­Derived, Coordinate­System derived­CS)	Creates a derived coordinate reference system from a conversion.
Ellipsoid	create­Ellipsoid(Map<String,?> properties, double semi­Major­Axis, double semi­Minor­Axis, Unit<Length> unit)	Creates an ellipsoid from semi-axis length values.
Ellipsoidal­CS	create­Ellipsoidal­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1)	Creates an ellipsoidal coordinate system without ellipsoidal height.
Ellipsoidal­CS	create­Ellipsoidal­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1, Coordinate­System­Axis axis2)	Creates an ellipsoidal coordinate system with ellipsoidal height.
Engineering­CRS	create­Engineering­CRS(Map<String,?> properties, Engineering­Datum datum, Default­Datum­Ensemble<Engineering­Datum> ensemble, Coordinate­System cs)	Creates a engineering coordinate reference system.
Engineering­CRS	create­Engineering­CRS(Map<String,?> properties, Engineering­Datum datum, Coordinate­System cs)	Creates a engineering CRS with a datum that may be a datum ensemble.
Engineering­Datum	create­Engineering­Datum(Map<String,?> properties)	Creates an engineering datum.
Ellipsoid	create­Flattened­Sphere(Map<String,?> properties, double semi­Major­Axis, double inverse­Flattening, Unit<Length> unit)	Creates an ellipsoid from a major semi-axis length and inverse flattening.
Coordinate­Reference­System	create­From­WKT(String wkt)	Creates a Coordinate Reference System object from a Well Known Text (WKT).
Coordinate­Reference­System	create­From­XML(String xml)	Creates a coordinate reference system object from a XML string.
Geocentric­CRS	create­Geocentric­CRS(Map<String,?> properties, Geodetic­Datum datum, Cartesian­CS cs)	Creates a geocentric coordinate reference system from a Cartesian coordinate system.
Geocentric­CRS	create­Geocentric­CRS(Map<String,?> properties, Geodetic­Datum datum, Spherical­CS cs)	Deprecated. ISO 19111:2019 does not define an explicit class for geocentric CRS.
Geodetic­CRS	create­Geodetic­CRS(Map<String,?> properties, Geodetic­Datum datum, Default­Datum­Ensemble<Geodetic­Datum> ensemble, Cartesian­CS cs)	Creates a geocentric coordinate reference system from a Cartesian coordinate system.
Geodetic­CRS	create­Geodetic­CRS(Map<String,?> properties, Geodetic­Datum datum, Default­Datum­Ensemble<Geodetic­Datum> ensemble, Spherical­CS cs)	Creates a geocentric coordinate reference system from a spherical coordinate system.
Geodetic­Datum	create­Geodetic­Datum(Map<String,?> properties, Ellipsoid ellipsoid, Prime­Meridian prime­Meridian)	Creates a static geodetic reference frame from ellipsoid and (optionally) Bursa-Wolf parameters.
Geodetic­Datum	create­Geodetic­Datum(Map<String,?> properties, Ellipsoid ellipsoid, Prime­Meridian prime­Meridian, Temporal epoch)	Creates a dynamic geodetic reference frame from ellipsoid and frame reference epoch.
Geographic­CRS	create­Geographic­CRS(Map<String,?> properties, Geodetic­Datum datum, Default­Datum­Ensemble<Geodetic­Datum> ensemble, Ellipsoidal­CS cs)	Creates a geographic coordinate reference system.
Geographic­CRS	create­Geographic­CRS(Map<String,?> properties, Geodetic­Datum datum, Ellipsoidal­CS cs)	Creates a geographic CRS with a datum that may be a datum ensemble.
Image­CRS	create­Image­CRS(Map<String,?> properties, Image­Datum datum, Affine­CS cs)	Deprecated. The Image­CRS class has been removed in ISO 19111:2019.
Image­Datum	create­Image­Datum(Map<String,?> properties, Pixel­In­Cell pixel­In­Cell)	Deprecated. The Image­Datum class has been removed in ISO 19111:2019.
Linear­CS	create­Linear­CS(Map<String,?> properties, Coordinate­System­Axis axis)	Creates a linear coordinate system.
Default­Parametric­CRS	create­Parametric­CRS(Map<String,?> properties, Default­Parametric­Datum datum, Default­Parametric­CS cs)	Creates a parametric CRS from a datum.
Default­Parametric­CRS	create­Parametric­CRS(Map<String,?> properties, Default­Parametric­Datum datum, Default­Datum­Ensemble<Default­Parametric­Datum> ensemble, Default­Parametric­CS cs)	Creates a parametric coordinate reference system.
Default­Parametric­CS	create­Parametric­CS(Map<String,?> properties, Coordinate­System­Axis axis)	Creates a parametric coordinate system.
Default­Parametric­Datum	create­Parametric­Datum(Map<String,?> properties)	Creates a parametric datum.
Polar­CS	create­Polar­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1)	Creates a polar coordinate system from the given pair of axis.
Prime­Meridian	create­Prime­Meridian(Map<String,?> properties, double longitude, Unit<Angle> angular­Unit)	Creates a prime meridian, relative to Greenwich.
Projected­CRS	create­Projected­CRS(Map<String,?> properties, Geographic­CRS base­CRS, Conversion base­To­Derived, Cartesian­CS derived­CS)	Creates a projected coordinate reference system from a conversion.
Spherical­CS	create­Spherical­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1)	Creates a spherical coordinate system without radius.
Spherical­CS	create­Spherical­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1, Coordinate­System­Axis axis2)	Creates a spherical coordinate system from the given set of axis.
Temporal­CRS	create­Temporal­CRS(Map<String,?> properties, Temporal­Datum datum, Default­Datum­Ensemble<Temporal­Datum> ensemble, Time­CS cs)	Creates a temporal coordinate reference system.
Temporal­CRS	create­Temporal­CRS(Map<String,?> properties, Temporal­Datum datum, Time­CS cs)	Creates a temporal CRS with a datum that may be a datum ensemble.
Temporal­Datum	create­Temporal­Datum(Map<String,?> properties, Date origin)	Creates a temporal datum from an enumerated type value.
Time­CS	create­Time­CS(Map<String,?> properties, Coordinate­System­Axis axis)	Creates a temporal coordinate system.
User­Defined­CS	create­User­Defined­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1)	Deprecated. The User­Defined­CS class has been removed from ISO 19111:2019.
User­Defined­CS	create­User­Defined­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1, Coordinate­System­Axis axis2)	Deprecated. The User­Defined­CS class has been removed from ISO 19111:2019.
Vertical­CRS	create­Vertical­CRS(Map<String,?> properties, Vertical­Datum datum, Default­Datum­Ensemble<Vertical­Datum> ensemble, Vertical­CS cs)	Creates a vertical coordinate reference system.
Vertical­CRS	create­Vertical­CRS(Map<String,?> properties, Vertical­Datum datum, Vertical­CS cs)	Creates a vertical CRS with a datum that may be a datum ensemble.
Vertical­CS	create­Vertical­CS(Map<String,?> properties, Coordinate­System­Axis axis)	Creates a vertical coordinate system.
Vertical­Datum	create­Vertical­Datum(Map<String,?> properties, Vertical­Datum­Type type)	Creates a vertical datum from an enumerated type value.
Vertical­Datum	create­Vertical­Datum(Map<String,?> properties, Vertical­Datum­Type type, Temporal epoch)	Creates a dynamic vertical datum from an enumerated type value and a frame reference epoch.
static Geodetic­Object­Factory	provider()	Returns the default provider of Identified­Object instances.

Methods inherited from class AbstractFactory

get­Vendor, to­String

Methods inherited from class Object

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

Methods inherited from interface Factory

get­Vendor

Constructor Details

GeodeticObjectFactory

public GeodeticObjectFactory()

Constructs a factory with no default properties.

See Also:

• provider()

GeodeticObjectFactory

public GeodeticObjectFactory(Map<String,?> properties)

Constructs a factory with the given default properties. Geodetic­Object­Factory will fallback on the map given to this constructor for any property not present in the map provided to a create­Foo(Map<String,?>, …) method.

Parameters:

properties - the default properties, or null if none.

Method Details

provider

public static GeodeticObjectFactory provider()

Returns the default provider of Identified­Object instances. This is the factory used by the Apache SIS library when no non-null CRSFactory, CSFactory or Datum­Factory has been explicitly specified. This method can be invoked directly, or indirectly through Service­Loader.load(T) where T is one of above-cited interfaces.

Returns:

the default provider of geodetic objects.

Since:

1.4

See Also:

• Service­Loader

complete

protected Map<String,?> complete(Map<String,?> properties)

Returns the union of the given properties map with the default properties given at construction time. Entries in the given properties map have precedence, even if their value is null (i.e. a null value "erase" the default property value). Entries with null value after the union will be omitted.

This method is invoked by all create­Foo(Map<String,?>, …) methods. Subclasses can override this method if they want to add, remove or edit property values with more flexibility than constant values specified at construction time.

Parameters:

properties - the properties supplied in a call to a create­Foo(Map, …) method.

Returns:

the union of the given properties with the default properties.

createGeodeticCRS

public GeodeticCRS createGeodeticCRS(Map<String,?> properties,
 GeodeticDatum datum,
 DefaultDatumEnsemble<GeodeticDatum> ensemble,
 CartesianCS cs)
                              throws FactoryException

Creates a geocentric coordinate reference system from a Cartesian coordinate system. Geocentric CRS have their origin at the approximate centre of mass of the earth. An alternate method allows creation of the same kind of CRS with spherical coordinate system instead of a Cartesian one.

Warning: In a future SIS version, the return type may be changed to the Geodetic­CRS parent interface. This is because ISO 19111 does not defines specific interface for the geocentric case. Users should assign the return value to a Geodetic­CRS type.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. create­Cartesian­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)
3. One of:
   • create­Ellipsoid(Map, double, double, Unit)
   • create­Flattened­Sphere(Map, double, double, Unit)
4. create­Prime­Meridian(Map, double, Unit)
5. create­Geodetic­Datum(Map, Ellipsoid, Prime­Meridian)
6. create­Datum­Ensemble(Map, Collection, Positional­Accuracy) (optional)

At least one of the datum and ensemble arguments shall be non-null. The default implementation creates a Default­Geocentric­CRS instance.

Parameters:

properties - name and other properties to give to the new object.

datum - geodetic reference frame, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of reference frames which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the three-dimensional Cartesian coordinate system for the created CRS.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Default­Geocentric­CRS(Map, Geodetic­Datum, Default­Datum­Ensemble, Cartesian­CS)
• invalid reference

  Geodetic­Authority­Factory#create­Geodetic­CRS(String)

createGeocentricCRS

public GeocentricCRS createGeocentricCRS(Map<String,?> properties,
 GeodeticDatum datum,
 CartesianCS cs)
                                  throws FactoryException

Creates a geocentric coordinate reference system from a Cartesian coordinate system.

Specified by:

create­Geocentric­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

datum - the geodetic datum to use in created CRS.

cs - the three-dimensional Cartesian coordinate system for the created CRS.

Returns:

The coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Geodetic­Authority­Factory.create­Geocentric­CRS(String)
• Default­Geocentric­CRS(Map, Geodetic­Datum, Cartesian­CS)

createCartesianCS

public CartesianCS createCartesianCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1,
 CoordinateSystemAxis axis2)
                              throws FactoryException

Creates a three-dimensional Cartesian coordinate system from the given set of axis. This coordinate system can be used with geocentric, engineering and derived CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Cartesian­CS instance.

Specified by:

create­Cartesian­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis (e.g. “Geocentric X”).

axis1 - the second axis (e.g. “Geocentric Y”).

axis2 - the third axis (e.g. “Geocentric Z”).

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Cartesian­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Cartesian­CS(String)

createGeodeticCRS

public GeodeticCRS createGeodeticCRS(Map<String,?> properties,
 GeodeticDatum datum,
 DefaultDatumEnsemble<GeodeticDatum> ensemble,
 SphericalCS cs)
                              throws FactoryException

Creates a geocentric coordinate reference system from a spherical coordinate system. Geocentric CRS have their origin at the approximate centre of mass of the earth. An alternate method allows creation of the same kind of CRS with Cartesian coordinate system instead of a spherical one.

Warning: In a future SIS version, the return type may be changed to the Geodetic­CRS parent interface. This is because ISO 19111 does not defines specific interface for the geocentric case. Users should assign the return value to a Geodetic­CRS type.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. create­Spherical­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)
3. One of:
   • create­Ellipsoid(Map, double, double, Unit)
   • create­Flattened­Sphere(Map, double, double, Unit)
4. create­Prime­Meridian(Map, double, Unit)
5. create­Geodetic­Datum(Map, Ellipsoid, Prime­Meridian)
6. create­Datum­Ensemble(Map, Collection, Positional­Accuracy) (optional)

At least one of the datum and ensemble arguments shall be non-null. The default implementation creates a Default­Geocentric­CRS instance.

Parameters:

properties - name and other properties to give to the new object.

datum - geodetic reference frame, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of reference frames which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the spherical coordinate system for the created CRS.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Default­Geocentric­CRS(Map, Geodetic­Datum, Default­Datum­Ensemble, Spherical­CS)
• invalid reference

  Geodetic­Authority­Factory#create­Geodetic­CRS(String)

createGeocentricCRS

@Deprecated
public GeocentricCRS createGeocentricCRS(Map<String,?> properties,
 GeodeticDatum datum,
 SphericalCS cs)
                                  throws FactoryException

Deprecated.

ISO 19111:2019 does not define an explicit class for geocentric CRS. Use

invalid reference

#create­Geodetic­CRS(Map, Geodetic­Datum, Spherical­CS)

instead.

Creates a geocentric coordinate reference system from a spherical coordinate system.

Specified by:

create­Geocentric­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

datum - the geodetic datum to use in created CRS.

cs - the three-dimensional Cartesian coordinate system for the created CRS.

Returns:

The coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

createSphericalCS

public SphericalCS createSphericalCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1,
 CoordinateSystemAxis axis2)
                              throws FactoryException

Creates a spherical coordinate system from the given set of axis. This coordinate system can be used with geocentric, engineering and derived CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Spherical­CS instance.

Specified by:

create­Spherical­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis (e.g. “Spherical latitude”).

axis1 - the second axis (e.g. “Spherical longitude”).

axis2 - the third axis (e.g. “Geocentric radius”).

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Spherical­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Spherical­CS(String)

createSphericalCS

public SphericalCS createSphericalCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1)
                              throws FactoryException

Creates a spherical coordinate system without radius. This coordinate system can be used with geocentric, engineering and derived CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Spherical­CS instance.

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis (e.g. “Spherical latitude”).

axis1 - the second axis (e.g. “Spherical longitude”).

Throws:

Factory­Exception - if the object creation failed.

Since:

1.4

See Also:

• Default­Spherical­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)

createGeographicCRS

public GeographicCRS createGeographicCRS(Map<String,?> properties,
 GeodeticDatum datum,
 DefaultDatumEnsemble<GeodeticDatum> ensemble,
 EllipsoidalCS cs)
                                  throws FactoryException

Creates a geographic coordinate reference system. It can be (latitude, longitude) or (longitude, latitude), optionally with an ellipsoidal height.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. One of:
   • create­Ellipsoidal­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)
   • create­Ellipsoidal­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)
3. One of:
   • create­Ellipsoid(Map, double, double, Unit)
   • create­Flattened­Sphere(Map, double, double, Unit)
4. create­Prime­Meridian(Map, double, Unit)
5. create­Geodetic­Datum(Map, Ellipsoid, Prime­Meridian)
6. create­Datum­Ensemble(Map, Collection, Positional­Accuracy) (optional)

At least one of the datum and ensemble arguments shall be non-null. The default implementation creates a Default­Geographic­CRS instance.

Parameters:

properties - name and other properties to give to the new object.

datum - geodetic reference frame, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of reference frames which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the two- or three-dimensional ellipsoidal coordinate system for the created CRS.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Default­Geographic­CRS(Map, Geodetic­Datum, Default­Datum­Ensemble, Ellipsoidal­CS)
• Geodetic­Authority­Factory.create­Geographic­CRS(String)

createGeographicCRS

public GeographicCRS createGeographicCRS(Map<String,?> properties,
 GeodeticDatum datum,
 EllipsoidalCS cs)
                                  throws FactoryException

Creates a geographic CRS with a datum that may be a datum ensemble. If the given datum argument is a datum ensemble viewed as a pseudo-datum, then it is used as the ensemble argument of the above constructor.

Specified by:

create­Geographic­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

datum - the geodetic reference frame or datum ensemble viewed as a pseudo-datum.

cs - the two- or three-dimensional ellipsoidal coordinate system for the created CRS.

Returns:

the coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

createDatumEnsemble

public <D extends Datum> DefaultDatumEnsemble<D> createDatumEnsemble(Map<String,?> properties,
 Collection<? extends D> members,
 PositionalAccuracy accuracy)
                                                              throws FactoryException

Creates a datum ensemble from a collection of members and an ensemble accuracy.

Upcoming API change — generalization
The element type will be changed to the Datum­Ensemble interface when GeoAPI will provide it (tentatively in GeoAPI 3.1).

Type Parameters:

D - the type of datum contained in the ensemble.

Parameters:

properties - name and other properties to give to the new object.

members - datum or reference frames which are members of the datum ensemble.

accuracy - inaccuracy introduced through use of the given collection of datums.

Returns:

the datum ensemble for the given properties.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

createGeodeticDatum

public GeodeticDatum createGeodeticDatum(Map<String,?> properties,
 Ellipsoid ellipsoid,
 PrimeMeridian primeMeridian)
                                  throws FactoryException

Creates a static geodetic reference frame from ellipsoid and (optionally) Bursa-Wolf parameters. Geodetic reference frame defines the location and orientation of an ellipsoid that approximates the shape of the earth. This datum can be used with geographic and geocentric CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. One of:
   • create­Ellipsoid(Map, double, double, Unit)
   • create­Flattened­Sphere(Map, double, double, Unit)
2. create­Prime­Meridian(Map, double, Unit)

The default implementation creates a Default­Geodetic­Datum instance.

Specified by:

create­Geodetic­Datum in interface Datum­Factory

Parameters:

properties - name and other properties to give to the new object.

ellipsoid - the ellipsoid to use in new geodetic reference frame.

prime­Meridian - the prime meridian to use in new geodetic reference frame.

Returns:

The datum for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Geodetic­Datum(Map, Ellipsoid, Prime­Meridian)
• Geodetic­Authority­Factory.create­Geodetic­Datum(String)

createGeodeticDatum

public GeodeticDatum createGeodeticDatum(Map<String,?> properties,
 Ellipsoid ellipsoid,
 PrimeMeridian primeMeridian,
 Temporal epoch)
                                  throws FactoryException

Creates a dynamic geodetic reference frame from ellipsoid and frame reference epoch. The arguments are the same as for the static datum, with the addition of a mandatory frame reference epoch.

Parameters:

properties - name and other properties to give to the new object.

ellipsoid - the ellipsoid to use in new geodetic reference frame.

prime­Meridian - the prime meridian to use in new geodetic reference frame.

epoch - the epoch to which the definition of the dynamic reference frame is referenced.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Dynamic(Map, Ellipsoid, Prime­Meridian, Temporal)
• Geodetic­Authority­Factory.create­Geodetic­Datum(String)

createPrimeMeridian

public PrimeMeridian createPrimeMeridian(Map<String,?> properties,
 double longitude,
 Unit<Angle> angularUnit)
                                  throws FactoryException

Creates a prime meridian, relative to Greenwich. Defines the origin from which longitude values are determined.

The default implementation creates a Default­Prime­Meridian instance.

Specified by:

create­Prime­Meridian in interface Datum­Factory

Parameters:

properties - name and other properties to give to the new object.

longitude - the longitude of prime meridian in supplied angular units East of Greenwich.

angular­Unit - the angular units of longitude.

Returns:

The prime meridian for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Prime­Meridian(Map, double, Unit)
• Geodetic­Authority­Factory.create­Prime­Meridian(String)

createEllipsoidalCS

public EllipsoidalCS createEllipsoidalCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1)
                                  throws FactoryException

Creates an ellipsoidal coordinate system without ellipsoidal height. It can be (latitude, longitude) or (longitude, latitude).

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Ellipsoidal­CS instance.

Specified by:

create­Ellipsoidal­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis (e.g. “Geodetic latitude”).

axis1 - the second axis (e.g. “Geodetic longitude”).

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Ellipsoidal­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Ellipsoidal­CS(String)

createEllipsoidalCS

public EllipsoidalCS createEllipsoidalCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1,
 CoordinateSystemAxis axis2)
                                  throws FactoryException

Creates an ellipsoidal coordinate system with ellipsoidal height. It can be (latitude, longitude, height) or (longitude, latitude, height).

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Ellipsoidal­CS instance.

Specified by:

create­Ellipsoidal­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis (e.g. “Geodetic latitude”).

axis1 - the second axis (e.g. “Geodetic longitude”).

axis2 - the third axis (e.g. “Ellipsoidal height”).

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Ellipsoidal­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Ellipsoidal­CS(String)

createEllipsoid

public Ellipsoid createEllipsoid(Map<String,?> properties,
 double semiMajorAxis,
 double semiMinorAxis,
 Unit<Length> unit)
                          throws FactoryException

Creates an ellipsoid from semi-axis length values. The default implementation creates a Default­Ellipsoid instance.

Specified by:

create­Ellipsoid in interface Datum­Factory

Parameters:

properties - name and other properties to give to the new object.

semi­Major­Axis - the equatorial radius in supplied linear units.

semi­Minor­Axis - the polar radius in supplied linear units.

unit - the linear units of ellipsoid axes.

Returns:

The ellipsoid for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Ellipsoid.create­Ellipsoid(Map, double, double, Unit)
• Geodetic­Authority­Factory.create­Ellipsoid(String)

createFlattenedSphere

public Ellipsoid createFlattenedSphere(Map<String,?> properties,
 double semiMajorAxis,
 double inverseFlattening,
 Unit<Length> unit)
                                throws FactoryException

Creates an ellipsoid from a major semi-axis length and inverse flattening. The default implementation creates a Default­Ellipsoid instance.

Specified by:

create­Flattened­Sphere in interface Datum­Factory

Parameters:

properties - name and other properties to give to the new object.

semi­Major­Axis - the equatorial radius in supplied linear units.

inverse­Flattening - the eccentricity of ellipsoid.

unit - the linear units of major axis.

Returns:

The ellipsoid for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Ellipsoid.create­Flattened­Sphere(Map, double, double, Unit)
• Geodetic­Authority­Factory.create­Ellipsoid(String)

createProjectedCRS

public ProjectedCRS createProjectedCRS(Map<String,?> properties,
 GeographicCRS baseCRS,
 Conversion baseToDerived,
 CartesianCS derivedCS)
                                throws FactoryException

Creates a projected coordinate reference system from a conversion. Projected CRS are used to approximate the shape of the earth on a planar surface in such a way that the distortion that is inherent to the approximation is controlled and known.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. create­Cartesian­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)
3. create­Ellipsoidal­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)
4. One of:
   • create­Ellipsoid(Map, double, double, Unit)
   • create­Flattened­Sphere(Map, double, double, Unit)
5. create­Prime­Meridian(Map, double, Unit)
6. create­Geodetic­Datum(Map, Ellipsoid, Prime­Meridian)
7. create­Geographic­CRS(Map, Geodetic­Datum, Ellipsoidal­CS)
8. Default­Coordinate­Operation­Factory.create­Defining­Conversion(Map, Operation­Method, Parameter­Value­Group)

The supplied conversion argument shall not includes the operation steps for performing unit conversions and change of axis order since those operations will be inferred by this constructor.

The default implementation creates a Default­Projected­CRS instance.

Specified by:

create­Projected­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

base­CRS - the geographic coordinate reference system to base projection on.

base­To­Derived - the defining conversion from a normalized base to a normalized derived CRS.

derived­CS - the coordinate system for the projected CRS.

Returns:

The coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Projected­CRS(Map, Geographic­CRS, Conversion, Cartesian­CS)
• Geodetic­Authority­Factory.create­Projected­CRS(String)

createCartesianCS

public CartesianCS createCartesianCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1)
                              throws FactoryException

Creates a two-dimensional Cartesian coordinate system from the given pair of axis. This coordinate system can be used with projected, engineering and derived CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Cartesian­CS instance.

Specified by:

create­Cartesian­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis (e.g. “Easting”).

axis1 - the second axis (e.g. “Northing”).

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Cartesian­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Cartesian­CS(String)

createDerivedCRS

public DerivedCRS createDerivedCRS(Map<String,?> properties,
 CoordinateReferenceSystem baseCRS,
 Conversion baseToDerived,
 CoordinateSystem derivedCS)
                            throws FactoryException

Creates a derived coordinate reference system from a conversion. The derived CRS returned by this method may also implement the Geodetic­CRS, Vertical­CRS, Temporal­CRS or Engineering­CRS interface depending on the type of the base CRS and the coordinate system.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. A create­Foo­CS(…) method for Cartesian, spherical, ellipsoidal, vertical, temporal, linear, affine, polar, cylindrical or user-defined CS.
3. Another create­Foo­CRS(…) method for geocentric, geographic, vertical, temporal or engineering CRS.
4. Default­Coordinate­Operation­Factory.create­Defining­Conversion(Map, Operation­Method, Parameter­Value­Group)

The supplied conversion argument shall not includes the operation steps for performing unit conversions and change of axis order since those operations will be inferred by this constructor.

The default implementation creates a Default­Derived­CRS instance.

Specified by:

create­Derived­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

base­CRS - the coordinate reference system to base projection on. Shall be an instance of Single­CRS.

base­To­Derived - the defining conversion from a normalized base to a normalized derived CRS.

derived­CS - the coordinate system for the derived CRS.

Returns:

The coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Derived­CRS.create(Map, Single­CRS, Conversion, Coordinate­System)
• Geodetic­Authority­Factory.create­Derived­CRS(String)

createVerticalCRS

public VerticalCRS createVerticalCRS(Map<String,?> properties,
 VerticalDatum datum,
 DefaultDatumEnsemble<VerticalDatum> ensemble,
 VerticalCS cs)
                              throws FactoryException

Creates a vertical coordinate reference system. 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.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. create­Vertical­CS(Map, Coordinate­System­Axis)
3. create­Vertical­Datum(Map, Vertical­Datum­Type)
4. create­Datum­Ensemble(Map, Collection, Positional­Accuracy) (optional)

At least one of the datum and ensemble arguments shall be non-null. The default implementation creates a Default­Vertical­CRS instance.

Parameters:

properties - name and other properties to give to the new object.

datum - vertical reference frame, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of reference frames which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the vertical coordinate system for the created CRS.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Default­Vertical­CRS(Map, Vertical­Datum, Default­Datum­Ensemble, Vertical­CS)
• Geodetic­Authority­Factory.create­Vertical­CRS(String)

createVerticalCRS

public VerticalCRS createVerticalCRS(Map<String,?> properties,
 VerticalDatum datum,
 VerticalCS cs)
                              throws FactoryException

Creates a vertical CRS with a datum that may be a datum ensemble. If the given datum argument is a datum ensemble viewed as a pseudo-datum, then it is used as the ensemble argument of the above constructor.

Specified by:

create­Vertical­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

datum - the vertical reference frame or datum ensemble viewed as a pseudo-datum.

cs - the vertical coordinate system for the created CRS.

Returns:

the coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

createVerticalDatum

public VerticalDatum createVerticalDatum(Map<String,?> properties,
 VerticalDatumType type)
                                  throws FactoryException

Creates a vertical datum from an enumerated type value. The default implementation creates a Default­Vertical­Datum instance.

Specified by:

create­Vertical­Datum in interface Datum­Factory

Parameters:

properties - name and other properties to give to the new object.

type - the type of this vertical datum (often geoidal).

Returns:

The datum for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Vertical­Datum(Map, Vertical­Datum­Type)
• Geodetic­Authority­Factory.create­Vertical­Datum(String)

createVerticalDatum

public VerticalDatum createVerticalDatum(Map<String,?> properties,
 VerticalDatumType type,
 Temporal epoch)
                                  throws FactoryException

Creates a dynamic vertical datum from an enumerated type value and a frame reference epoch. The arguments are the same as for the static datum, with the addition of a mandatory frame reference epoch.

Parameters:

properties - name and other properties to give to the new object.

type - the type of this vertical datum (often geoidal).

epoch - the epoch to which the definition of the dynamic reference frame is referenced.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Dynamic(Map, Vertical­Datum­Type, Temporal)
• Geodetic­Authority­Factory.create­Vertical­Datum(String)

createVerticalCS

public VerticalCS createVerticalCS(Map<String,?> properties,
 CoordinateSystemAxis axis)
                            throws FactoryException

Creates a vertical coordinate system. This coordinate system can be used with vertical and derived CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Vertical­CS instance.

Specified by:

create­Vertical­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis - the single axis (e.g. “height” or “depth”).

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Vertical­CS(Map, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Vertical­CS(String)

createTemporalCRS

public TemporalCRS createTemporalCRS(Map<String,?> properties,
 TemporalDatum datum,
 DefaultDatumEnsemble<TemporalDatum> ensemble,
 TimeCS cs)
                              throws FactoryException

Creates a temporal coordinate reference system.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. create­Time­CS(Map, Coordinate­System­Axis)
3. create­Temporal­Datum(Map, Date)
4. create­Datum­Ensemble(Map, Collection, Positional­Accuracy) (optional)

At least one of the datum and ensemble arguments shall be non-null. The default implementation creates a Default­Temporal­CRS instance.

Parameters:

properties - name and other properties to give to the new object.

datum - temporal datum, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of datum which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the temporal coordinate system for the created CRS.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Default­Temporal­CRS(Map, Temporal­Datum, Default­Datum­Ensemble, Time­CS)
• Geodetic­Authority­Factory.create­Temporal­CRS(String)

createTemporalCRS

public TemporalCRS createTemporalCRS(Map<String,?> properties,
 TemporalDatum datum,
 TimeCS cs)
                              throws FactoryException

Creates a temporal CRS with a datum that may be a datum ensemble. If the given datum argument is a datum ensemble viewed as a pseudo-datum, then it is used as the ensemble argument of the above constructor.

Specified by:

create­Temporal­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

datum - the temporal datum or datum ensemble viewed as a pseudo-datum.

cs - the temporal coordinate system for the created CRS.

Returns:

the coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

createTemporalDatum

public TemporalDatum createTemporalDatum(Map<String,?> properties,
 Date origin)
                                  throws FactoryException

Creates a temporal datum from an enumerated type value. The default implementation creates a Default­Temporal­Datum instance.

Specified by:

create­Temporal­Datum in interface Datum­Factory

Parameters:

properties - name and other properties to give to the new object.

origin - the date and time origin of this temporal datum.

Returns:

The datum for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Temporal­Datum(Map, Date)
• Geodetic­Authority­Factory.create­Temporal­Datum(String)

createTimeCS

public TimeCS createTimeCS(Map<String,?> properties,
 CoordinateSystemAxis axis)
                    throws FactoryException

Creates a temporal coordinate system. This coordinate system can be used with temporal and derived CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Time­CS instance.

Specified by:

create­Time­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis - the single axis.

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Time­CS(Map, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Time­CS(String)

createParametricCRS

public DefaultParametricCRS createParametricCRS(Map<String,?> properties,
 DefaultParametricDatum datum,
 DefaultDatumEnsemble<DefaultParametricDatum> ensemble,
 DefaultParametricCS cs)
                                         throws FactoryException

Creates a parametric coordinate reference system. Parametric CRS can be used for physical properties or functions that vary monotonically with height. A typical example is the pressure in meteorological applications.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. create­Parametric­CS(Map, Coordinate­System­Axis)
3. create­Parametric­Datum(Map)
4. create­Datum­Ensemble(Map, Collection, Positional­Accuracy) (optional)

At least one of the datum and ensemble arguments shall be non-null. The default implementation creates a Default­Parametric­CRS instance.

Warning: in a future SIS version, the parameter types may be changed to org.opengis.referencing.datum.Parametric­Datum and org.opengis.referencing.cs.Parametric­CS, and the return type may be changed to org.opengis.referencing.crs.Parametric­CRS. Those change are pending GeoAPI revision.

Parameters:

properties - name and other properties to give to the new object.

datum - parametric datum, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of datum which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the parametric coordinate system for the created CRS.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Default­Parametric­CRS(Map, Default­Parametric­Datum, Default­Datum­Ensemble, Parametric­CS)
• Geodetic­Authority­Factory.create­Parametric­CRS(String)

createParametricCRS

public DefaultParametricCRS createParametricCRS(Map<String,?> properties,
 DefaultParametricDatum datum,
 DefaultParametricCS cs)
                                         throws FactoryException

Creates a parametric CRS from a datum. This is a shortcut for the more generic method without datum ensemble.

Parameters:

properties - name and other properties to give to the new object.

datum - the parametric datum or datum ensemble viewed as a pseudo-datum.

cs - the parametric coordinate system for the created CRS.

Returns:

the coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

createParametricDatum

public DefaultParametricDatum createParametricDatum(Map<String,?> properties)
                                             throws FactoryException

Creates a parametric datum. The default implementation creates a Default­Parametric­Datum instance.

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:

properties - name and other properties to give to the new object.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Parametric­Datum(Map)
• Geodetic­Authority­Factory.create­Parametric­Datum(String)

createParametricCS

public DefaultParametricCS createParametricCS(Map<String,?> properties,
 CoordinateSystemAxis axis)
                                       throws FactoryException

Creates a parametric coordinate system. This coordinate system can be used only with parametric CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Parametric­CS instance.

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:

properties - name and other properties to give to the new object.

axis - the single axis.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Parametric­CS(Map, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Parametric­CS(String)

createCompoundCRS

public CompoundCRS createCompoundCRS(Map<String,?> properties,
 CoordinateReferenceSystem... components)
                              throws FactoryException

Creates a compound coordinate reference system from an ordered list of CRS components. Apache SIS is permissive on the order of components that can be used in a compound CRS. However for better inter-operability, users are encouraged to follow the order mandated by ISO 19162:

1. A mandatory horizontal CRS (only one of two-dimensional Geographic­CRS or Projected­CRS or Engineering­CRS).
2. Optionally followed by a Vertical­CRS or a Parametric­CRS (but not both).
3. Optionally followed by a Temporal­CRS.

The default implementation creates a Default­Compound­CRS instance.

Specified by:

create­Compound­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

components - the sequence of coordinate reference systems making the compound CRS.

Returns:

The coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Compound­CRS(Map, Coordinate­Reference­System...)
• Geodetic­Authority­Factory.create­Compound­CRS(String)
• CRS.compound(Coordinate­Reference­System...)

createImageCRS

@Deprecated(since="1.5")
public ImageCRS createImageCRS(Map<String,?> properties,
 ImageDatum datum,
 AffineCS cs)
                        throws FactoryException

Deprecated.

The Image­CRS class has been removed in ISO 19111:2019. It is replaced by Engineering­CRS.

Creates an image coordinate reference system. The default implementation creates a Default­Image­CRS instance.

Specified by:

create­Image­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

datum - the image datum to use in created CRS.

cs - the Cartesian or oblique Cartesian coordinate system for the created CRS.

Returns:

The coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Image­CRS(Map, Image­Datum, Affine­CS)
• Geodetic­Authority­Factory.create­Image­CRS(String)

createImageDatum

@Deprecated(since="1.5")
public ImageDatum createImageDatum(Map<String,?> properties,
 PixelInCell pixelInCell)
                            throws FactoryException

Deprecated.

The Image­Datum class has been removed in ISO 19111:2019. It is replaced by Engineering­Datum.

Creates an image datum. The default implementation creates a Default­Image­Datum instance.

Specified by:

create­Image­Datum in interface Datum­Factory

Parameters:

properties - Name and other properties to give to the new object.

pixel­In­Cell - Specification of the way the image grid is associated with the image data attributes.

Returns:

The datum for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Image­Datum(Map, Pixel­In­Cell)
• Geodetic­Authority­Factory.create­Image­Datum(String)

createAffineCS

public AffineCS createAffineCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1)
                        throws FactoryException

Creates a two-dimensional affine coordinate system from the given pair of axis. This coordinate system can be used with image and engineering CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Affine­CS instance.

Specified by:

create­Affine­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis.

axis1 - the second axis.

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Affine­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)

createEngineeringCRS

public EngineeringCRS createEngineeringCRS(Map<String,?> properties,
 EngineeringDatum datum,
 DefaultDatumEnsemble<EngineeringDatum> ensemble,
 CoordinateSystem cs)
                                    throws FactoryException

Creates a engineering coordinate reference system. Engineering CRS can be divided into two broad categories:

• earth-fixed systems applied to engineering activities on or near the surface of the earth;
• CRSs on moving platforms such as road vehicles, vessels, aircraft, or spacecraft.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
2. A create­Foo­CS(…) method for Cartesian, spherical, linear, affine, polar, cylindrical or user-defined CS.
3. create­Engineering­Datum(Map)
4. create­Datum­Ensemble(Map, Collection, Positional­Accuracy) (optional)

At least one of the datum and ensemble arguments shall be non-null. The default implementation creates a Default­Engineering­CRS instance.

Parameters:

properties - name and other properties to give to the new object.

datum - engineering datum, or null if the CRS is associated only to a datum ensemble.

ensemble - collection of datum which for low accuracy requirements may be considered to be insignificantly different from each other, or null if there is no such ensemble.

cs - the coordinate system for the created CRS.

Throws:

Factory­Exception - if the object creation failed.

Since:

1.5

See Also:

• Default­Engineering­CRS(Map, Engineering­Datum, Coordinate­System)
• Geodetic­Authority­Factory.create­Engineering­CRS(String)

createEngineeringCRS

public EngineeringCRS createEngineeringCRS(Map<String,?> properties,
 EngineeringDatum datum,
 CoordinateSystem cs)
                                    throws FactoryException

Creates a engineering CRS with a datum that may be a datum ensemble. If the given datum argument is a datum ensemble viewed as a pseudo-datum, then it is used as the ensemble argument of the above constructor.

Specified by:

create­Engineering­CRS in interface CRSFactory

Parameters:

properties - name and other properties to give to the new object.

datum - the engineering datum or datum ensemble viewed as a pseudo-datum.

cs - the coordinate system for the created CRS.

Returns:

the coordinate reference system for the given properties.

Throws:

Factory­Exception - if the object creation failed.

createEngineeringDatum

public EngineeringDatum createEngineeringDatum(Map<String,?> properties)
                                        throws FactoryException

Creates an engineering datum. The default implementation creates a Default­Engineering­Datum instance.

Specified by:

create­Engineering­Datum in interface Datum­Factory

Parameters:

properties - name and other properties to give to the new object.

Returns:

The datum for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Engineering­Datum(Map)
• Geodetic­Authority­Factory.create­Engineering­Datum(String)

createAffineCS

public AffineCS createAffineCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1,
 CoordinateSystemAxis axis2)
                        throws FactoryException

Creates a three-dimensional affine coordinate system from the given set of axis. This coordinate system can be used with engineering CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Affine­CS instance.

Specified by:

create­Affine­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis.

axis1 - the second axis.

axis2 - the third axis.

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Affine­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)

createCylindricalCS

public CylindricalCS createCylindricalCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1,
 CoordinateSystemAxis axis2)
                                  throws FactoryException

Creates a cylindrical coordinate system from the given set of axis. This coordinate system can be used with engineering CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Cylindrical­CS instance.

Specified by:

create­Cylindrical­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis.

axis1 - the second axis.

axis2 - the third axis.

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Cylindrical­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Cylindrical­CS(String)

createPolarCS

public PolarCS createPolarCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1)
                      throws FactoryException

Creates a polar coordinate system from the given pair of axis. This coordinate system can be used with engineering CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Polar­CS instance.

Specified by:

create­Polar­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis.

axis1 - the second axis.

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Polar­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)
• Geodetic­Authority­Factory.create­Polar­CS(String)

createLinearCS

public LinearCS createLinearCS(Map<String,?> properties,
 CoordinateSystemAxis axis)
                        throws FactoryException

Creates a linear coordinate system. This coordinate system can be used with engineering CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­Linear­CS instance.

Specified by:

create­Linear­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis - the single axis.

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Linear­CS(Map, Coordinate­System­Axis)

createUserDefinedCS

@Deprecated(since="1.5")
public UserDefinedCS createUserDefinedCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1)
                                  throws FactoryException

Deprecated.

The User­Defined­CS class has been removed from ISO 19111:2019.

Creates a two-dimensional user defined coordinate system from the given pair of axis. This coordinate system can be used with engineering CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­User­Defined­CS instance.

Specified by:

create­User­Defined­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis.

axis1 - the second axis.

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­User­Defined­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis)

createUserDefinedCS

@Deprecated(since="1.5")
public UserDefinedCS createUserDefinedCS(Map<String,?> properties,
 CoordinateSystemAxis axis0,
 CoordinateSystemAxis axis1,
 CoordinateSystemAxis axis2)
                                  throws FactoryException

Deprecated.

The User­Defined­CS class has been removed from ISO 19111:2019.

Creates a three-dimensional user defined coordinate system from the given set of axis. This coordinate system can be used with engineering CRS.

Dependencies

The components needed by this method can be created by the following methods:

1. create­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)

The default implementation creates a Default­User­Defined­CS instance.

Specified by:

create­User­Defined­CS in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

axis0 - the first axis.

axis1 - the second axis.

axis2 - the third axis.

Returns:

The coordinate system for the given properties and axes.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­User­Defined­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis)

createCoordinateSystemAxis

public CoordinateSystemAxis createCoordinateSystemAxis(Map<String,?> properties,
 String abbreviation,
 AxisDirection direction,
 Unit<?> unit)
                                                throws FactoryException

Creates a coordinate system axis from an abbreviation and a unit. Note that the axis name is constrained by ISO 19111 depending on the coordinate reference system type. See the GeoAPI Coordinate­System­Axis javadoc for more information.

The default implementation creates a Default­Coordinate­System­Axis instance.

Specified by:

create­Coordinate­System­Axis in interface CSFactory

Parameters:

properties - name and other properties to give to the new object.

abbreviation - the coordinate axis abbreviation.

direction - the axis direction.

unit - the coordinate axis unit.

Returns:

The axis for the given properties.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• Default­Coordinate­System­Axis(Map, String, Axis­Direction, Unit)
• Geodetic­Authority­Factory.create­Coordinate­System­Axis(String)

createFromXML

public CoordinateReferenceSystem createFromXML(String xml)
                                        throws FactoryException

Creates a coordinate reference system object from a XML string. Note that the given argument is the XML document itself, not a URL to a XML document.

The default implementation delegates to XML.unmarshal(String)

Specified by:

create­From­XML in interface CRSFactory

Parameters:

xml - coordinate reference system encoded in XML format.

Returns:

The coordinate reference system for the given XML.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• XML.unmarshal(String)
• CRS.from­XML(String)

createFromWKT

public CoordinateReferenceSystem createFromWKT(String wkt)
                                        throws FactoryException

Creates a Coordinate Reference System object from a Well Known Text (WKT). This method understands both version 1 (a.k.a. OGC 01-009) and version 2 (a.k.a. ISO 19162) of the WKT format.

Example

Below is a slightly simplified WKT 2 string for a Mercator projection. For making this example smaller, some optional UNIT[…] and ORDER[…] elements have been omitted.

ProjectedCRS["SIRGAS 2000 / Brazil Mercator",
  BaseGeogCRS["SIRGAS 2000",
    Datum["Sistema de Referencia Geocentrico para las Americas 2000",
      Ellipsoid["GRS 1980", 6378137, 298.257222101]]],
  Conversion["Petrobras Mercator",
    Method["Mercator (variant B)", Id["EPSG",9805]],
    Parameter["Latitude of 1st standard parallel", -2],
    Parameter["Longitude of natural origin", -43],
    Parameter["False easting", 5000000],
    Parameter["False northing", 10000000]],
  CS[cartesian,2],
    Axis["easting (E)", east],
    Axis["northing (N)", north],
    LengthUnit["metre", 1],
  Id["EPSG",5641]]

Logging

If the given text contains non-fatal anomalies (unknown or unsupported WKT elements, inconsistent unit definitions, unparsable axis abbreviations, etc.), warnings may be reported in a logger named "org.apache.sis.io.wkt". However, this parser does not verify if the overall parsed object matches the EPSG (or other authority) definition, since this geodetic object factory is not an authority factory. For such verification, see the CRS.from­WKT(String) convenience method.

Usage and performance considerations

The default implementation uses a shared instance of WKTFormat with the addition of thread-safety. This is okay for occasional use, but is sub-optimal if this method is extensively used in a multi-thread environment. Furthermore, this method offers no control on the WKT conventions in use and on the handling of warnings. Applications which need to parse a large number of WKT strings should consider to use the WKTFormat class instead of this method.

Specified by:

create­From­WKT in interface CRSFactory

Specified by:

create­From­WKT in interface Parser

Parameters:

wkt - coordinate system encoded in Well-Known Text format (version 1 or 2).

Returns:

The coordinate reference system for the given WKT.

Throws:

Factory­Exception - if the object creation failed.

See Also:

• org.apache.sis.io.wkt
• CRS.from­WKT(String)