Package org.apache.sis.referencing.crs
Class DefaultParametricCRS
Object
FormattableObject
AbstractIdentifiedObject
AbstractReferenceSystem
AbstractCRS
DefaultParametricCRS
- All Implemented Interfaces:
Serializable,Formattable,Deprecable,LenientComparable,CoordinateReferenceSystem,SingleCRS,IdentifiedObject,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
- See Also:
Defined in the sis-referencing module
-
Field Summary
Fields inherited from class AbstractIdentifiedObject
DEPRECATED_KEY, LOCALE_KEYFields inherited from interface IdentifiedObject
ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEYFields inherited from interface ReferenceSystem
DOMAIN_OF_VALIDITY_KEY, SCOPE_KEY -
Constructor Summary
ConstructorsModifierConstructorDescriptionDefaultParametricCRS(Map<String, ?> properties, DefaultParametricDatum datum, DefaultParametricCS cs) Creates a coordinate reference system from the given properties, datum and coordinate system.protectedConstructs a new coordinate reference system with the same values than the specified one. -
Method Summary
Modifier and TypeMethodDescriptionforConvention(AxesConvention convention) Returns a coordinate reference system equivalent to this one but with axes rearranged according the given convention.protected StringFormats this CRS as a Well Known TextParametricCRS[…]element.Returns the coordinate system.Returns the datum.Methods inherited from class AbstractCRS
castOrCopy, computeHashCode, equals, getInterfaceMethods inherited from class AbstractReferenceSystem
getDomainOfValidity, getScopeMethods inherited from class AbstractIdentifiedObject
castOrCopy, equals, formatTo, getAlias, getDescription, getIdentifiers, getName, getRemarks, hashCode, isDeprecated, isHeuristicMatchForNameMethods inherited from class FormattableObject
print, toString, toString, toWKTMethods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface IdentifiedObject
getAlias, getIdentifiers, getName, getRemarks, toWKTMethods inherited from interface ReferenceSystem
getDomainOfValidity, getScope
-
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" IdentifierorStringAbstractIdentifiedObject.getName()"alias" GenericNameorCharSequence(optionally as array)AbstractIdentifiedObject.getAlias()"identifiers" Identifier(optionally as array)AbstractIdentifiedObject.getIdentifiers()"remarks" InternationalStringorStringAbstractIdentifiedObject.getRemarks()"domainOfValidity" ExtentAbstractReferenceSystem.getDomainOfValidity()"scope" InternationalStringorStringAbstractReferenceSystem.getScope()Warning: in a future SIS version, the parameter types may be changed toorg.opengis.referencing.datum.ParametricDatumandorg.opengis.referencing.cs.ParametricCSThose 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.
-
-
Method Details
-
getDatum
Returns the datum.- Specified by:
getDatumin interfaceSingleCRS- Returns:
- the datum.
-
getCoordinateSystem
Returns the coordinate system.- Specified by:
getCoordinateSystemin interfaceCoordinateReferenceSystem- Specified by:
getCoordinateSystemin interfaceSingleCRS- Overrides:
getCoordinateSystemin 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:
forConventionin 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:
-
formatTo
Formats this CRS as a Well Known TextParametricCRS[…]element.Compatibility note:ParametricCRSis defined in the WKT 2 specification only.- Overrides:
formatToin classAbstractCRS- Parameters:
formatter- the formatter where to format the inner content of this WKT element.- Returns:
"ParametricCRS".- See Also:
-