org.opengis.geometry.coordinate
Class Handed

Show UML class diagram

Object
  CodeList<Handed>
      Handed

All Implemented Interfaces:

Serializable, Comparable<Handed>

@Draft
@UML(identifier="GM_Handed",
     specification=ISO_19107)
public class Handed
extends CodeList<Handed>

Labels coordinate systems as being right or left handed as commonly defined in Mathematics. This really only has meaning if the coordinate system is spatial. This is needed since most mathematical algorithms need to know or potentially modify the handedness of a coordinate system to maintain the proper representation of space.

Note: The default for mathematics is right-handed systems (classic x-y, or x-y-z order in Cartesian coordinates), while many geographic coordinate reference systems are left-handed. This mathematical choice is seen in several decisions; such as the inside of a surface is to the left of its boundary, the inside of a solid is below its boundary, and the very concepts of oriented primitives and algebraic topology. This bias toward right-handed systems is also seen in computer graphics and in engineering.

Since:

3.1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class CodeList

CodeList.Filter

Field Summary

static Handed	LEFT The left-handed systems (y-x-z), for example Latitude/Longitude.
static Handed	RIGHT The right-handed systems (classic x-y-z).

Method Summary

Handed[]	family() Returns the list of enumerations of the same kind than this enum.
static Handed	valueOf(String code) Returns the Handed orientation form that matches the given string, or returns a new one if none match it.
static Handed[]	values() Returns the list of Handeds.

Methods inherited from class CodeList

compareTo, equals, identifier, name, names, ordinal, readResolve, toString, valueOf, valueOf

Methods inherited from class Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RIGHT

@Draft
@UML(identifier="right",
     obligation=CONDITIONAL,
     specification=ISO_19107)
public static final Handed RIGHT

The right-handed systems (classic x-y-z).

LEFT

@Draft
@UML(identifier="left",
     obligation=CONDITIONAL,
     specification=ISO_19107)
public static final Handed LEFT

The left-handed systems (y-x-z), for example Latitude/Longitude.

Method Detail

values

public static Handed[] values()

Returns the list of Handeds.

Returns:

The list of codes declared in the current JVM.

family

public Handed[] family()

Returns the list of enumerations of the same kind than this enum.

Specified by:

family in class CodeList<Handed>

Returns:

The codes of the same kind than this code.

valueOf

public static Handed valueOf(String code)

Returns the Handed orientation form that matches the given string, or returns a new one if none match it. More specifically, this methods returns the first instance for which name().equals(code) returns true. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - The name of the code to fetch or to create.

Returns:

A code matching the given name.