org.jscience.ml.gml.infoset
Interface CoordinateTuple

All Known Subinterfaces:
Coord
All Known Implementing Classes:
CoordImpl, CoordinateTupleImpl

public interface CoordinateTuple

Defines the interface that every GML coordinate tuple must implement. A coordinate tuple does NOT have a corresponding GML element. It is an abstraction of a coordinate tuple, which may appear in coord and coordinates GML constructs. Coord, which is a coordinate tuple with a corresponding GML element, extends this interface.


Field Summary
static int X_INDEX
          DOCUMENT ME!
static int Y_INDEX
          DOCUMENT ME!
static int Z_INDEX
          DOCUMENT ME!
 
Method Summary
 Coordinate getCoordinate(int index)
          Returns the n-th coordinate of this coordinate tuple.
 Coordinate getX()
          Convenience method to retrieve the first coordinate.
 Coordinate getY()
          Convenience method to retrieve the second coordinate.
 Coordinate getZ()
          Convenience method to retrieve the third coordinate.
 

Field Detail

X_INDEX

static final int X_INDEX
DOCUMENT ME!

See Also:
Constant Field Values

Y_INDEX

static final int Y_INDEX
DOCUMENT ME!

See Also:
Constant Field Values

Z_INDEX

static final int Z_INDEX
DOCUMENT ME!

See Also:
Constant Field Values
Method Detail

getX

Coordinate getX()
Convenience method to retrieve the first coordinate.

Returns:
Cannot be null.

getY

Coordinate getY()
Convenience method to retrieve the second coordinate.

Returns:
Can be null if Y-coordinate is not present.

getZ

Coordinate getZ()
Convenience method to retrieve the third coordinate.

Returns:
Can be null if Z-coordinate is not present.

getCoordinate

Coordinate getCoordinate(int index)
Returns the n-th coordinate of this coordinate tuple.

Parameters:
index - Represents an index into the coordinate tuple. The lowest index is 0.
Returns:
Returns null if the index is out of range.