Package org.apache.sis.referencing.crs
Class DefaultParametricCRS
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.DefaultParametricCRS
- All Implemented Interfaces:
Serializable
,Formattable
,ParametricCRS
,Deprecable
,LenientComparable
,org.opengis.referencing.crs.CoordinateReferenceSystem
,org.opengis.referencing.crs.SingleCRS
,org.opengis.referencing.IdentifiedObject
,org.opengis.referencing.ReferenceSystem
A 1-dimensional coordinate reference system which uses parameter values or functions.
Parametric CRS can be used for physical properties or functions that vary monotonically with height.
A typical example is the pressure in meteorological applications.
Used with datum type:
Parametric.
Used with coordinate system type:
Parametric.
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.7
- Version:
- 0.7
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate DefaultParametricDatum
The datum.private static final long
Serial number for inter-operability with different versions.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.DefaultParametricCRS
(Map<String, ?> properties, DefaultParametricDatum datum, DefaultParametricCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protected
Constructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescription(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 TextParametricCRS[…]
element.Returns the coordinate system.getDatum()
Returns the datum.private void
Used by JAXB only (invoked by reflection).private void
setDatum
(DefaultParametricDatum value) Invoked by JAXB at unmarshalling time.Methods inherited from class org.apache.sis.referencing.crs.AbstractCRS
castOrCopy, computeHashCode, equals, formatCS, getCached, getCoordinateSystem, getInterface, 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
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
datum
The datum.Consider this field as final! This field is modified only at unmarshalling time by
setDatum(ParametricDatum)
- See Also:
-
-
Constructor Details
-
DefaultParametricCRS
public DefaultParametricCRS(Map<String, ?> properties, DefaultParametricDatum datum, DefaultParametricCS 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" Identifier
orString
AbstractIdentifiedObject.getName()
"alias" GenericName
orCharSequence
(optionally as array)AbstractIdentifiedObject.getAlias()
"identifiers" Identifier
(optionally as array)AbstractIdentifiedObject.getIdentifiers()
"remarks" InternationalString
orString
AbstractIdentifiedObject.getRemarks()
"domainOfValidity" Extent
AbstractReferenceSystem.getDomainOfValidity()
"scope" InternationalString
orString
AbstractReferenceSystem.getScope()
Warning: in a future SIS version, the parameter types may be changed toorg.opengis.referencing.datum.ParametricDatum
andorg.opengis.referencing.cs.ParametricCS
Those change are pending GeoAPI revision.- Parameters:
properties
- the properties to be given to the coordinate reference system.datum
- the datum.cs
- the coordinate system.
-
DefaultParametricCRS
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.
Warning: in a future SIS version, the parameter type may be changed toorg.opengis.referencing.crs.ParametricCRS
. This change is pending GeoAPI revision.- Parameters:
crs
- the coordinate reference system to copy.
-
DefaultParametricCRS
private DefaultParametricCRS()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
-
getDatum
Returns the datum.- Specified by:
getDatum
in interfaceorg.opengis.referencing.crs.SingleCRS
- Overrides:
getDatum
in classAbstractCRS
- Returns:
- the datum.
-
getCoordinateSystem
Returns the coordinate system.- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.CoordinateReferenceSystem
- Specified by:
getCoordinateSystem
in interfaceorg.opengis.referencing.crs.SingleCRS
- Overrides:
getCoordinateSystem
in classAbstractCRS
- Returns:
- the coordinate system.
-
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 TextParametricCRS[…]
element.Compatibility note:ParametricCRS
is defined in the WKT 2 specification only.- Overrides:
formatTo
in classAbstractCRS
- Parameters:
formatter
- the formatter where to format the inner content of this WKT element.- Returns:
"ParametricCRS"
.- See Also:
-
setDatum
Invoked by JAXB at unmarshalling time.- See Also:
-
setCoordinateSystem
Used by JAXB only (invoked by reflection).- See Also:
-