Package org.opengis.test.referencing

Class PseudoEpsgFactory

Object

PseudoFactory

PseudoEpsgFactory

All Implemented Interfaces:

AuthorityFactory, CRSAuthorityFactory, CSAuthorityFactory, DatumAuthorityFactory, Factory

public class PseudoEpsgFactory
extends PseudoFactory
implements DatumAuthorityFactory, CSAuthorityFactory, CRSAuthorityFactory

Creates referencing objects for a limited set of hard-coded EPSG codes using ObjectFactory and MathTransformFactory. This pseudo-factory can be used with implementation that do not support (or don't want to test) a "real" CRSAuthorityFactory for the EPSG database.

Since:

3.1

Field Summary

Fields

Modifier and Type	Field	Description
protected CoordinateOperationFactory	copFactory	Factory to use for building Conversion instances, or null if none.
protected CRSFactory	crsFactory	Factory to use for building CoordinateReferenceSystem instances, or null if none.
protected CSFactory	csFactory	Factory to use for building CoordinateSystem instances, or null if none.
protected DatumFactory	datumFactory	Factory to use for building Datum instances, or null if none.
protected MathTransformFactory	mtFactory	Factory to use for building MathTransform instances, or null if none.
protected Units	units	Provider of pre-defined Unit instances (degree, metre, second, etc).
protected ValidatorContainer	validators	The set of validators to use for verifying objects conformance (never null).

Constructor Summary

Constructors

Constructor	Description
PseudoEpsgFactory(Units units, DatumFactory datumFactory, CSFactory csFactory, CRSFactory crsFactory, CoordinateOperationFactory copFactory, MathTransformFactory mtFactory, ValidatorContainer validators)	Creates a new pseudo-factory which will use the given factories.

Method Summary

Modifier and Type	Method	Description
CartesianCS	createCartesianCS(String code)	Creates a Cartesian coordinate system from a code.
CompoundCRS	createCompoundCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
CoordinateReferenceSystem	createCoordinateReferenceSystem(String code)	Returns an arbitrary coordinate reference system from a code.
CoordinateSystem	createCoordinateSystem(String code)	Returns an arbitrary coordinate system from a code.
CoordinateSystemAxis	createCoordinateSystemAxis(String code)	Returns a coordinate system axis from a code.
CylindricalCS	createCylindricalCS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
Datum	createDatum(String code)	Returns an arbitrary datum from a code.
DerivedCRS	createDerivedCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
Ellipsoid	createEllipsoid(String code)	Returns an ellipsoid from a code.
EllipsoidalCS	createEllipsoidalCS(String code)	Creates an ellipsoidal coordinate system from a code.
EngineeringCRS	createEngineeringCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
EngineeringDatum	createEngineeringDatum(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
GeocentricCRS	createGeocentricCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
GeodeticDatum	createGeodeticDatum(String code)	Returns a geodetic datum from a code.
GeographicCRS	createGeographicCRS(String code)	Returns a geographic coordinate reference system from a code.
ImageCRS	createImageCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
ImageDatum	createImageDatum(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
IdentifiedObject	createObject(String code)	Returns an arbitrary object from a code.
protected ParameterValueGroup	createParameters(int code)	Returns the parameters to use for creating the coordinate operation identified by the given EPSG code.
ParametricCRS	createParametricCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
ParametricCS	createParametricCS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
ParametricDatum	createParametricDatum(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
PolarCS	createPolarCS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
PrimeMeridian	createPrimeMeridian(String code)	Returns a prime meridian from a EPSG code.
ProjectedCRS	createProjectedCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
protected Map<String,Object>	createPropertiesMap(int code, String name)	Builds a map of properties for a referencing object to be build.
SphericalCS	createSphericalCS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
TemporalCRS	createTemporalCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
TemporalDatum	createTemporalDatum(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
TimeCS	createTimeCS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
Unit<?>	createUnit(String code)	Returns an unit from a code.
VerticalCRS	createVerticalCRS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
VerticalCS	createVerticalCS(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
VerticalDatum	createVerticalDatum(String code)	The default implementation throws NoSuchAuthorityCodeException unconditionally.
Citation	getAuthority()	The default implementation returns null.
Set<String>	getAuthorityCodes(Class<? extends IdentifiedObject> type)	The default implementation returns an empty set.
InternationalString	getDescriptionText(String code)	The default implementation returns null.

Methods inherited from class PseudoFactory

getVendor

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Factory

getVendor

Field Detail

units

protected final Units units

Provider of pre-defined Unit instances (degree, metre, second, etc).

datumFactory

protected final DatumFactory datumFactory

Factory to use for building Datum instances, or null if none.

csFactory

protected final CSFactory csFactory

Factory to use for building CoordinateSystem instances, or null if none.

crsFactory

protected final CRSFactory crsFactory

Factory to use for building CoordinateReferenceSystem instances, or null if none.

copFactory

protected final CoordinateOperationFactory copFactory

Factory to use for building Conversion instances, or null if none.

mtFactory

protected final MathTransformFactory mtFactory

Factory to use for building MathTransform instances, or null if none.

validators

protected final ValidatorContainer validators

The set of validators to use for verifying objects conformance (never null).

Constructor Detail

PseudoEpsgFactory

public PseudoEpsgFactory(Units units,
                         DatumFactory datumFactory,
                         CSFactory csFactory,
                         CRSFactory crsFactory,
                         CoordinateOperationFactory copFactory,
                         MathTransformFactory mtFactory,
                         ValidatorContainer validators)

Creates a new pseudo-factory which will use the given factories.

Parameters:

units - provider of pre-defined Unit instances.

datumFactory - factory for creating Datum instances.

csFactory - factory for creating CoordinateSystem instances.

crsFactory - factory for creating CoordinateReferenceSystem instances.

copFactory - factory for creating Conversion instances.

mtFactory - factory for creating MathTransform instances.

validators - the set of validators to use for verifying objects conformance, Can not be null; if there is no particular validators, use Validators.DEFAULT.

Method Detail

getAuthority

public Citation getAuthority()

The default implementation returns null.

Specified by:

getAuthority in interface AuthorityFactory

getAuthorityCodes

public Set<String> getAuthorityCodes(Class<? extends IdentifiedObject> type)
                              throws FactoryException

The default implementation returns an empty set.

Specified by:

getAuthorityCodes in interface AuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

TODO:

Needs to be implemented.

getDescriptionText

public InternationalString getDescriptionText(String code)
                                       throws FactoryException

The default implementation returns null.

Specified by:

getDescriptionText in interface AuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createPropertiesMap

protected Map<String,Object> createPropertiesMap(int code,
                                                       String name)

Builds a map of properties for a referencing object to be build. The map shall contains at least the IdentifiedObject.NAME_KEY identifier associated to the given value. Subclasses can override this method in order to provide more information if they wish.

Parameters:

code - The EPSG code of the object being built.

name - The name of the object being built.

Returns:

a map containing the properties for the object to create.

createObject

public IdentifiedObject createObject(String code)
                              throws FactoryException

Returns an arbitrary object from a code.

Supported codes

Code	Name
4326	WGS 84
6326	World Geodetic System 1984
6422	Ellipsoidal 2D CS. Axes: latitude, longitude. Orientations: north, east. UoM: degree

Specified by:

createObject in interface AuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

FactoryException - if the object creation failed.

createDatum

public Datum createDatum(String code)
                  throws FactoryException

Returns an arbitrary datum from a code.

Supported codes

Code	Name
6326	World Geodetic System 1984

Specified by:

createDatum in interface DatumAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

FactoryException - if the object creation failed.

createEngineeringDatum

public EngineeringDatum createEngineeringDatum(String code)
                                        throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createEngineeringDatum in interface DatumAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createImageDatum

public ImageDatum createImageDatum(String code)
                            throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createImageDatum in interface DatumAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createVerticalDatum

public VerticalDatum createVerticalDatum(String code)
                                  throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createVerticalDatum in interface DatumAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createTemporalDatum

public TemporalDatum createTemporalDatum(String code)
                                  throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createTemporalDatum in interface DatumAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createParametricDatum

public ParametricDatum createParametricDatum(String code)
                                      throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createParametricDatum in interface DatumAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createGeodeticDatum

public GeodeticDatum createGeodeticDatum(String code)
                                  throws FactoryException

Returns a geodetic datum from a code.

Supported codes

Code	Name
6326	World Geodetic System 1984
6284	Pulkovo 1942

Specified by:

createGeodeticDatum in interface DatumAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the datum for the given code.

Throws:

FactoryException - if the object creation failed.

createEllipsoid

public Ellipsoid createEllipsoid(String code)
                          throws FactoryException

Returns an ellipsoid from a code.

Supported codes

Code	Name
7001	Airy 1830
7004	Bessel 1841
7011	Clarke 1880 (IGN)
7019	GRS 1980
7022	International 1924
7024	Krassowsky 1940
7030	WGS 84

Specified by:

createEllipsoid in interface DatumAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the ellipsoid for the given code.

Throws:

FactoryException - if the object creation failed.

createPrimeMeridian

public PrimeMeridian createPrimeMeridian(String code)
                                  throws FactoryException

Returns a prime meridian from a EPSG code.

Supported codes

Code	Name
8901	Greenwich
8903	Paris
8908	Jakarta

Specified by:

createPrimeMeridian in interface DatumAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the prime meridian for the given code.

Throws:

FactoryException - if the object creation failed.

createCoordinateSystem

public CoordinateSystem createCoordinateSystem(String code)
                                        throws FactoryException

Returns an arbitrary coordinate system from a code.

Supported codes

Code	Name
6422	Ellipsoidal 2D CS. Axes: latitude, longitude. Orientations: north, east. UoM: degree

Specified by:

createCoordinateSystem in interface CSAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

FactoryException - if the object creation failed.

createCartesianCS

public CartesianCS createCartesianCS(String code)
                              throws FactoryException

Creates a Cartesian coordinate system from a code.

Supported codes

Code	Name
6500	Earth centred, earth fixed, righthanded 3D coordinate system, consisting of 3 orthogonal axes with X and Y axes in the equatorial plane, positive Z-axis parallel to mean earth rotation axis and pointing towards North Pole. UoM: m

Specified by:

createCartesianCS in interface CSAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

FactoryException - if the object creation failed.

createPolarCS

public PolarCS createPolarCS(String code)
                      throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createPolarCS in interface CSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createCylindricalCS

public CylindricalCS createCylindricalCS(String code)
                                  throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createCylindricalCS in interface CSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createSphericalCS

public SphericalCS createSphericalCS(String code)
                              throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createSphericalCS in interface CSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createEllipsoidalCS

public EllipsoidalCS createEllipsoidalCS(String code)
                                  throws FactoryException

Creates an ellipsoidal coordinate system from a code.

Supported codes

Code	Name
6403	Ellipsoidal 2D CS. Axes: latitude, longitude. Orientations: north, east. UoM: grads.
6422	Ellipsoidal 2D CS. Axes: latitude, longitude. Orientations: north, east. UoM: degree
6423	Ellipsoidal 3D CS. Axes: latitude, longitude, ellipsoidal height. Orientations: north, east, up. UoM: degree, degree, metre.
6424	Ellipsoidal 2D CS. Axes: longitude, latitude. Orientations: east, north. UoM: degree

Specified by:

createEllipsoidalCS in interface CSAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the coordinate system for the given code.

Throws:

FactoryException - if the object creation failed.

createVerticalCS

public VerticalCS createVerticalCS(String code)
                            throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createVerticalCS in interface CSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createTimeCS

public TimeCS createTimeCS(String code)
                    throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createTimeCS in interface CSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createParametricCS

public ParametricCS createParametricCS(String code)
                                throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createParametricCS in interface CSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createCoordinateSystemAxis

public CoordinateSystemAxis createCoordinateSystemAxis(String code)
                                                throws FactoryException

Returns a coordinate system axis from a code.

Supported codes

Code	Name	Unit
58	Geodetic latitude	grad
59	Geodetic longitude	grad
106, 108, 221	Geodetic latitude	degree
107, 109, 220	Geodetic longitude	degree
110	Ellipsoidal height	metre
115	Geocentric X	metre
116	Geocentric Y	metre
117	Geocentric Z	metre

Specified by:

createCoordinateSystemAxis in interface CSAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the axis for the given code.

Throws:

FactoryException - if the object creation failed.

createUnit

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

Returns an unit from a code.

Supported codes

Code	Name
9001	metre
9102	degree
9105	grad
9122	degree (supplier to define representation)

Specified by:

createUnit in interface CSAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the unit for the given code.

Throws:

FactoryException - if the object creation failed.

createCoordinateReferenceSystem

public CoordinateReferenceSystem createCoordinateReferenceSystem(String code)
                                                          throws FactoryException

Returns an arbitrary coordinate reference system from a code.

Supported codes

Code	Name
4326	WGS 84

Specified by:

createCoordinateReferenceSystem in interface CRSAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

FactoryException - if the object creation failed.

createCompoundCRS

public CompoundCRS createCompoundCRS(String code)
                              throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createCompoundCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createDerivedCRS

public DerivedCRS createDerivedCRS(String code)
                            throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createDerivedCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createEngineeringCRS

public EngineeringCRS createEngineeringCRS(String code)
                                    throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createEngineeringCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createGeographicCRS

public GeographicCRS createGeographicCRS(String code)
                                  throws FactoryException

Returns a geographic coordinate reference system from a code.

Supported codes

Code	Name
4326	WGS 84
4284	Pulkovo 1942

Specified by:

createGeographicCRS in interface CRSAuthorityFactory

Parameters:

code - value allocated by authority.

Returns:

the coordinate reference system for the given code.

Throws:

FactoryException - if the object creation failed.

createGeocentricCRS

public GeocentricCRS createGeocentricCRS(String code)
                                  throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createGeocentricCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createImageCRS

public ImageCRS createImageCRS(String code)
                        throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createImageCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createProjectedCRS

public ProjectedCRS createProjectedCRS(String code)
                                throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createProjectedCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createTemporalCRS

public TemporalCRS createTemporalCRS(String code)
                              throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createTemporalCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createVerticalCRS

public VerticalCRS createVerticalCRS(String code)
                              throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createVerticalCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createParametricCRS

public ParametricCRS createParametricCRS(String code)
                                  throws FactoryException

The default implementation throws NoSuchAuthorityCodeException unconditionally.

Specified by:

createParametricCRS in interface CRSAuthorityFactory

Throws:

FactoryException - if this method can not provide the requested information.

createParameters

protected ParameterValueGroup createParameters(int code)
                                        throws FactoryException

Returns the parameters to use for creating the coordinate operation identified by the given EPSG code. The coordinate operation is typically a map projection used by exactly one projected CRS, which is listed in the second column for information purpose.

The supported codes are determined from the set of examples published in the EPSG guidance document, augmented with other sources (IGNF). The following table lists the supported codes. Codes in italics are not official EPSG codes.

Supported codes

Code	Used by CRS	CRS or transformation name	Operation method
19905	3002	Makassar / NEIEZ	Mercator (variant A)
19884	3388	Pulkovo 1942 / Caspian Sea Mercator	Mercator (variant B)
3856	3857	WGS 84 / Pseudo-Mercator	Popular Visualisation Pseudo Mercator
310642901	310642901	IGNF:MILLER	Miller_Cylindrical
19958	29873	Timbalai 1948 / RSO Borneo (m)	Hotine Oblique Mercator (variant B)
19916	27700	OSGB 1936 / British National Grid	Transverse Mercator
17529	2053	South African Survey Grid zone 29	Transverse Mercator
19975	2314	Trinidad 1903 / Trinidad Grid	Cassini-Soldner
19910	24200	JAD69 / Jamaica National Grid	Lambert Conic Conformal (1SP)
14204	32040	NAD27 / Texas South Central	Lambert Conic Conformal (2SP)
6198	6201	Michigan CS27 Central zone	Lambert Conic Conformal (2SP Michigan)
19902	31300	Belge 1972 / Belge Lambert 72	Lambert Conic Conformal (2SP Belgium)
19986	3035	ETRS89 / LAEA Europe	Lambert Azimuthal Equal Area
16061	5041	WGS 84 / UPS North (E,N)	Polar Stereographic (variant A)
19993	3032	WGS 84 / Australian Antarctic Polar	Polar Stereographic (variant B)
19983	2985	Petrels 1972 / Terre Adelie Polar Stereographic	Polar Stereographic (variant C)
19914	28992	Amersfoort / RD New	Oblique Stereographic
9818	9818	Polyconic	Polyconic
19952	2065	CRS S-JTSK (Ferro) / Krovak	Krovak
9605	4230	ED50 to WGS 84	Abridged Molodensky

Parameters:

code - the EPSG code of the coordinate operation to create.

Returns:

the coordinate operation (typically a map projection) parameters.

Throws:

FactoryException - if the given EPSG code is unknown to this factory.

See Also:

ParameterizedTransformTest, AuthorityFactoryTest