Package org.apache.sis.referencing.crs
Class DefaultEngineeringCRS
java.lang.Object
org.apache.sis.io.wkt.FormattableObject
org.apache.sis.referencing.AbstractIdentifiedObject
org.apache.sis.referencing.AbstractReferenceSystem
org.apache.sis.referencing.crs.AbstractCRS
org.apache.sis.referencing.crs.DefaultEngineeringCRS
- All Implemented Interfaces:
Serializable
,Formattable
,Deprecable
,LenientComparable
,org.opengis.referencing.crs.CoordinateReferenceSystem
,org.opengis.referencing.crs.EngineeringCRS
,org.opengis.referencing.crs.SingleCRS
,org.opengis.referencing.IdentifiedObject
,org.opengis.referencing.ReferenceSystem
public class DefaultEngineeringCRS
extends AbstractCRS
implements org.opengis.referencing.crs.EngineeringCRS
A 1-, 2- or 3-dimensional contextually local coordinate reference system.
It 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.
Used with datum type:
Engineering.
Used with coordinate system types:
Affine,
Cartesian,
Cylindrical,
Linear.
Polar,
Spherical or
User Defined.
Immutability and thread safety
This class is immutable and thus thread-safe if the property values (not necessarily the map itself), the coordinate system and the datum instances given to the constructor are also immutable. Unless otherwise noted in the javadoc, this condition holds if all components were created using only SIS factories and static constants.- Since:
- 0.4
- Version:
- 1.3
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.referencing.datum.EngineeringDatum
The datum.private static final long
Serial number for inter-operability with different versions.private static final Class<?>[]
The types for which a specialized method exists.Fields inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEY
Fields inherited from interface org.opengis.referencing.IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY
Fields inherited from interface org.opengis.referencing.ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Constructs a new object in which every attributes are set to a null value.DefaultEngineeringCRS
(Map<String, ?> properties, org.opengis.referencing.datum.EngineeringDatum datum, org.opengis.referencing.cs.CoordinateSystem cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protected
DefaultEngineeringCRS
(org.opengis.referencing.crs.EngineeringCRS crs) Constructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultEngineeringCRS
castOrCopy
(org.opengis.referencing.crs.EngineeringCRS object) Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation.(package private) final AbstractCRS
createSameType
(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Returns a coordinate reference system of the same type than this CRS but with different axes.forConvention
(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected String
Formats this CRS as a Well Known TextEngineeringCRS[…]
element.private org.opengis.referencing.cs.CoordinateSystem
Returns the coordinate system if it is not an instance of any of the types handled by specialized methods.private org.opengis.referencing.cs.AffineCS
Used by JAXB only (invoked by reflection).private org.opengis.referencing.cs.CartesianCS
private org.opengis.referencing.cs.CylindricalCS
org.opengis.referencing.datum.EngineeringDatum
getDatum()
Returns the datum.Class<? extends org.opengis.referencing.crs.EngineeringCRS>
Returns the GeoAPI interface implemented by this class.private org.opengis.referencing.cs.LinearCS
private org.opengis.referencing.cs.PolarCS
private org.opengis.referencing.cs.SphericalCS
private org.opengis.referencing.cs.UserDefinedCS
private void
setAbstractCS
(org.opengis.referencing.cs.CoordinateSystem cs) Used by JAXB only (invoked by reflection).private void
setAffineCS
(org.opengis.referencing.cs.AffineCS cs) Invoked by JAXB at unmarshalling time.private void
setCartesianCS
(org.opengis.referencing.cs.CartesianCS cs) private void
setCylindricalCS
(org.opengis.referencing.cs.CylindricalCS cs) private void
setDatum
(org.opengis.referencing.datum.EngineeringDatum value) Invoked by JAXB at unmarshalling time.private void
setLinearCS
(org.opengis.referencing.cs.LinearCS cs) private void
setPolarCS
(org.opengis.referencing.cs.PolarCS cs) private void
setSphericalCS
(org.opengis.referencing.cs.SphericalCS cs) private void
setUserDefinedCS
(org.opengis.referencing.cs.UserDefinedCS cs) Methods inherited from class org.apache.sis.referencing.crs.AbstractCRS
castOrCopy, computeHashCode, equals, formatCS, getCached, getCoordinateSystem, getCoordinateSystem, isBaseCRS, setCached, setCoordinateSystem
Methods inherited from class org.apache.sis.referencing.AbstractReferenceSystem
getDomainOfValidity, getScope
Methods inherited from class org.apache.sis.referencing.AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForName
Methods inherited from class org.apache.sis.io.wkt.FormattableObject
print, toString, toString, toWKT
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.referencing.IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKT
Methods inherited from interface org.opengis.referencing.ReferenceSystem
getDomainOfValidity, getScope
Methods inherited from interface org.opengis.referencing.crs.SingleCRS
getCoordinateSystem
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
datum
private org.opengis.referencing.datum.EngineeringDatum datumThe datum.Consider this field as final! This field is modified only at unmarshalling time by
setDatum(EngineeringDatum)
- See Also:
-
SPECIALIZED_TYPES
The types for which a specialized method exists. Not includingCartesianCS
, because this case is already covered byAffineCS
.
-
-
Constructor Details
-
DefaultEngineeringCRS
public DefaultEngineeringCRS(Map<String, ?> properties, org.opengis.referencing.datum.EngineeringDatum datum, org.opengis.referencing.cs.CoordinateSystem cs) Creates a coordinate reference system from the given properties, datum and coordinate system. The properties given in argument follow the same rules than for the super-class constructor. The following table is a reminder of main (not all) properties:Recognized properties (non exhaustive list) Property name Value type Returned by "name" ReferenceIdentifier
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" ReferenceIdentifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
"domainOfValidity" Extent
AbstractReferenceSystem.getDomainOfValidity()
"scope" InternationalString
orString
AbstractReferenceSystem.getScope()
- Parameters:
properties
- the properties to be given to the coordinate reference system.datum
- the datum.cs
- the coordinate system.- See Also:
-
DefaultEngineeringCRS
protected DefaultEngineeringCRS(org.opengis.referencing.crs.EngineeringCRS crs) Constructs a new coordinate reference system with the same values than the specified one. This copy constructor provides a way to convert an arbitrary implementation into a SIS one or a user-defined one (as a subclass), usually in order to leverage some implementation-specific API.This constructor performs a shallow copy, i.e. the properties are not cloned.
- Parameters:
crs
- the coordinate reference system to copy.- See Also:
-
DefaultEngineeringCRS
private DefaultEngineeringCRS()Constructs a new object in which every attributes are set to a null value. This is not a valid object. This constructor is strictly reserved to JAXB, which will assign values to the fields using reflection.
-
-
Method Details
-
castOrCopy
Returns a SIS coordinate reference system implementation with the same values than the given arbitrary implementation. If the given object isnull
, then this method returnsnull
. Otherwise if the given object is already a SIS implementation, then the given object is returned unchanged. Otherwise a new SIS implementation is created and initialized to the attribute values of the given object.- Parameters:
object
- the object to get as a SIS implementation, ornull
if none.- Returns:
- a SIS implementation containing the values of the given object (may be the
given object itself), or
null
if the argument was null.
-
getInterface
Returns the GeoAPI interface implemented by this class. The SIS implementation returnsEngineeringCRS.class
.Note for implementers: Subclasses usually do not need to override this method since GeoAPI does not defineEngineeringCRS
sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces.- Overrides:
getInterface
in classAbstractCRS
- Returns:
EngineeringCRS.class
or a user-defined sub-interface.
-
getDatum
public org.opengis.referencing.datum.EngineeringDatum getDatum()Returns the datum.- Specified by:
getDatum
in interfaceorg.opengis.referencing.crs.EngineeringCRS
- Specified by:
getDatum
in interfaceorg.opengis.referencing.crs.SingleCRS
- Overrides:
getDatum
in classAbstractCRS
- Returns:
- the datum.
-
forConvention
Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention. If this CRS is already compatible with the given convention, then this method returnsthis
.- Overrides:
forConvention
in classAbstractCRS
- Parameters:
convention
- the axes convention for which a coordinate reference system is desired.- Returns:
- a coordinate reference system compatible with the given convention (may be
this
). - See Also:
-
createSameType
final AbstractCRS createSameType(Map<String, ?> properties, org.opengis.referencing.cs.CoordinateSystem cs) Returns a coordinate reference system of the same type than this CRS but with different axes.- Overrides:
createSameType
in classAbstractCRS
-
formatTo
Formats this CRS as a Well Known TextEngineeringCRS[…]
element.- Overrides:
formatTo
in classAbstractCRS
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"EngineeringCRS"
(WKT 2) or"Local_CS"
(WKT 1).- See Also:
-
setDatum
private void setDatum(org.opengis.referencing.datum.EngineeringDatum value) Invoked by JAXB at unmarshalling time.- See Also:
-
getAffineCS
private org.opengis.referencing.cs.AffineCS getAffineCS()Used by JAXB only (invoked by reflection). Only one ofgetFooCS()
methods can return a non-null value.Implementation note: The usual way to handle<xs:choice>
with JAXB is to annotate a single method like below: However, our attempts to apply this approach worked forDefaultParameterValue
but not for this class: for an unknown reason, the unmarshalled CS object is empty.- See Also:
-
getCartesianCS
private org.opengis.referencing.cs.CartesianCS getCartesianCS() -
getCylindricalCS
private org.opengis.referencing.cs.CylindricalCS getCylindricalCS() -
getLinearCS
private org.opengis.referencing.cs.LinearCS getLinearCS() -
getPolarCS
private org.opengis.referencing.cs.PolarCS getPolarCS() -
getSphericalCS
private org.opengis.referencing.cs.SphericalCS getSphericalCS() -
getUserDefinedCS
private org.opengis.referencing.cs.UserDefinedCS getUserDefinedCS() -
setAffineCS
private void setAffineCS(org.opengis.referencing.cs.AffineCS cs) Invoked by JAXB at unmarshalling time. -
setCartesianCS
private void setCartesianCS(org.opengis.referencing.cs.CartesianCS cs) -
setCylindricalCS
private void setCylindricalCS(org.opengis.referencing.cs.CylindricalCS cs) -
setLinearCS
private void setLinearCS(org.opengis.referencing.cs.LinearCS cs) -
setPolarCS
private void setPolarCS(org.opengis.referencing.cs.PolarCS cs) -
setSphericalCS
private void setSphericalCS(org.opengis.referencing.cs.SphericalCS cs) -
setUserDefinedCS
private void setUserDefinedCS(org.opengis.referencing.cs.UserDefinedCS cs) -
getAbstractCS
private org.opengis.referencing.cs.CoordinateSystem getAbstractCS()Returns the coordinate system if it is not an instance of any of the types handled by specialized methods. It is the case ofEllipsoidalCS
,VerticalCS
,TimeCS
andParametricCS
. -
setAbstractCS
private void setAbstractCS(org.opengis.referencing.cs.CoordinateSystem cs) Used by JAXB only (invoked by reflection).
-