DefaultCartesianCS (Apache SIS 1.6 API) JavaScript is disabled on your browser.     Skip navigation links Overview Class Use Tree New Deprecated Index Search Help org.apache.sis.referencing org.apache.sis.referencing.cs DefaultCartesianCS Contents  Description Immutability and thread safety Field Summary Constructor Summary Method Summary Constructor Details DefaultCartesianCS(Map, CoordinateSystemAxis, CoordinateSystemAxis) DefaultCartesianCS(Map, CoordinateSystemAxis, CoordinateSystemAxis, CoordinateSystemAxis) DefaultCartesianCS(CartesianCS) Method Details castOrCopy(CartesianCS) getInterface() forConvention(AxesConvention) Hide sidebar  Show sidebar Class DefaultCartesianCS Object FormattableObject AbstractIdentifiedObject AbstractCS DefaultAffineCS DefaultCartesianCS All Implemented Interfaces: Serializable, Formattable, Deprecable, Lenient­Comparable, Printable, Affine­CS, Cartesian­CS, Coordinate­System, Identified­Object public class DefaultCartesianCS extends DefaultAffineCS implements CartesianCS A 2- or 3-dimensional Cartesian coordinate system made of straight orthogonal axes. All axes shall have the same linear unit of measure. Permitted associations Used with CRS Permitted axis names Geocentric “Geocentric X”, “Geocentric Y”, “Geocentric Z” Projected “Easting” or “Westing”, “Northing” or “Southing” Engineering 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.4 See Also: Geodetic­Authority­Factory​.create­Cartesian­CS(String) Serialized Form Field Summary Fields inherited from class AbstractIdentifiedObject DEPRECATED_KEY, DOMAINS_KEY, LOCALE_KEY Fields inherited from interface IdentifiedObject ALIAS_KEY, IDENTIFIERS_KEY, NAME_KEY, REMARKS_KEY Constructor Summary Constructors Modifier Constructor Description   Default­Cartesian­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1) Constructs a two-dimensional coordinate system from a set of properties.   Default­Cartesian­CS(Map<String,?> properties, Coordinate­System­Axis axis0, Coordinate­System­Axis axis1, Coordinate­System­Axis axis2) Constructs a three-dimensional coordinate system from a set of properties. protected Default­Cartesian­CS(Cartesian­CS original) Creates a new coordinate system with the same values as the specified one. Method Summary All MethodsStatic MethodsInstance MethodsConcrete Methods Modifier and Type Method Description static Default­Cartesian­CS cast­Or­Copy(Cartesian­CS object) Returns a SIS coordinate system implementation with the same values as the given arbitrary implementation. Default­Cartesian­CS for­Convention(Axes­Convention convention) Returns a coordinate system equivalent to this one but with axes rearranged according the given convention. Class<? extends Cartesian­CS> get­Interface() Returns the GeoAPI interface implemented by this class. Methods inherited from class DefaultAffineCS cast­Or­Copy Methods inherited from class AbstractCS cast­Or­Copy, format­To, get­Axis, get­Dimension, has­Same­Axes Methods inherited from class AbstractIdentifiedObject cast­Or­Copy, equals, format­To, get­Alias, get­Description, get­Domains, 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 CoordinateSystem get­Axis, get­Dimension Methods inherited from interface IdentifiedObject get­Alias, get­Identifiers, get­Name, get­Remarks, to­WKT Constructor Details DefaultCartesianCS public DefaultCartesianCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1) Constructs a two-dimensional 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" ReferenceIdentifier or String AbstractIdentifiedObject.getName() "alias" GenericName or Char­Sequence (optionally as array) AbstractIdentifiedObject.getAlias() "identifiers" ReferenceIdentifier (optionally as array) AbstractIdentifiedObject.getIdentifiers() "remarks" InternationalString or String AbstractIdentifiedObject.getRemarks() Parameters: properties - the properties to be given to the identified object. axis0 - the first axis (e.g. “Easting”). axis1 - the second axis (e.g. “Northing”). See Also: Geodetic­Object­Factory​.create­Cartesian­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis) DefaultCartesianCS public DefaultCartesianCS(Map<String,?> properties, CoordinateSystemAxis axis0, CoordinateSystemAxis axis1, CoordinateSystemAxis axis2) Constructs a three-dimensional coordinate system from a set of properties. The properties map is given unchanged to the super-class constructor. Parameters: properties - the properties to be given to the identified object. axis0 - the first axis (e.g. “Geocentric X”). axis1 - the second axis (e.g. “Geocentric Y”). axis2 - the third axis (e.g. “Geocentric Z”). See Also: Geodetic­Object­Factory​.create­Cartesian­CS(Map, Coordinate­System­Axis, Coordinate­System­Axis, Coordinate­System­Axis) DefaultCartesianCS protected DefaultCartesianCS(CartesianCS original) Creates a new coordinate system with the same values as 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: original - the coordinate system to copy. See Also: cast­Or­Copy(Cartesian­CS) Method Details castOrCopy public static DefaultCartesianCS castOrCopy(CartesianCS object) Returns a SIS coordinate system implementation with the same values as the given arbitrary implementation. If the given object is null, then this method returns null. 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, or null 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 public Class<? extends CartesianCS> getInterface() Returns the GeoAPI interface implemented by this class. The SIS implementation returns Cartesian­CS​.class. Note for implementers Subclasses usually do not need to override this method since GeoAPI does not define Cartesian­CS sub-interface. Overriding possibility is left mostly for implementers who wish to extend GeoAPI with their own set of interfaces. Overrides: get­Interface in class Default­Affine­CS Returns: Cartesian­CS​.class or a user-defined sub-interface. forConvention public DefaultCartesianCS 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 Default­Affine­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)