org.apache.sis.referencing.cs

Class DefaultParametricCS

Object

FormattableObject

AbstractIdentifiedObject

AbstractCS

DefaultParametricCS

All Implemented Interfaces:

Serializable, Deprecable, LenientComparable, CoordinateSystem, IdentifiedObject

public class DefaultParametricCS
extends AbstractCS

A 1-dimensional coordinate system for parametric values or functions.

Permitted associations

Used with CRS	Permitted axis names
Parametric	unspecified

Immutability and thread safety

This class is immutable and thus thread-safe if the property values (not necessarily the map itself) and the Coordinate­System­Axis 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:

Default­Parametric­CRS, Default­Parametric­Datum, Geodetic­Authority­Factory.create­Parametric­CS(String), Serialized Form

Defined in the sis-referencing module

Field Summary

Fields inherited from class AbstractIdentifiedObject

DEPRECATED_KEY, LOCALE_KEY

Fields inherited from interface IdentifiedObject

ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultParametricCS(DefaultParametricCS cs) Creates a new coordinate system with the same values than the specified one.
	DefaultParametricCS(Map<String,?> properties, CoordinateSystemAxis axis) Constructs a coordinate system from a set of properties.

Method Summary

Methods

Modifier and Type	Method and Description
DefaultParametricCS	forConvention(AxesConvention convention) Returns a coordinate system equivalent to this one but with axes rearranged according the given convention.

Methods inherited from class AbstractCS

cast­Or­Copy, compute­Hash­Code, equals, format­To, get­Axis, get­Dimension, get­Interface

Methods inherited from class AbstractIdentifiedObject

cast­Or­Copy, equals, get­Alias, get­Description, get­Identifiers, get­Name, get­Remarks, hash­Code, is­Deprecated, is­Heuristic­Match­For­Name

Methods inherited from class FormattableObject

print, to­String, to­String, to­WKT

Methods inherited from class Object

clone, finalize, get­Class, notify, notify­All, wait, wait, wait

Methods inherited from interface IdentifiedObject

get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT

Constructor Detail

DefaultParametricCS

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

Constructs a coordinate system from a set of properties. The properties map is given unchanged to 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 or String	AbstractIdentifiedObject.getName()
"alias"	GenericName or Char­Sequence (optionally as array)	AbstractIdentifiedObject.getAlias()
"identifiers"	Identifier (optionally as array)	AbstractIdentifiedObject.getIdentifiers()
"remarks"	InternationalString or String	AbstractIdentifiedObject.getRemarks()

Parameters:

properties - the properties to be given to the identified object.

axis - the axis.

See Also:

Geodetic­Object­Factory.create­Parametric­CS(Map, Coordinate­System­Axis)

DefaultParametricCS

protected DefaultParametricCS(DefaultParametricCS cs)

Creates a new coordinate 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 to org.opengis.referencing.cs.Parametric­CS. This change is pending GeoAPI revision.

Parameters:

cs - the coordinate system to copy.

Method Detail

forConvention

public DefaultParametricCS forConvention(AxesConvention convention)

Returns a coordinate system equivalent to this one but with axes rearranged according the given convention. If this coordinate system is already compatible with the given convention, then this method returns this.

Overrides:

for­Convention in class Abstract­CS

Parameters:

convention - the axes convention for which a coordinate system is desired.

Returns:

a coordinate system compatible with the given convention (may be this).

See Also:

Abstract­CRS.for­Convention(Axes­Convention)