org.osid.mapping

Interface Coordinate

All Superinterfaces:

java.lang.Comparable<Coordinate>, Coordinate, OsidPrimitive, java.io.Serializable

public interface Coordinate
extends OsidPrimitive, Coordinate

A coordinate represents a position.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	definesUncertainty() Tests if uncertainty is defined for this heading.
Type	getCoordinateType() Gets the Type of this Coordinate which indicates the format of the coordinate data.
long	getDimensions() Gets the number of dimensions available in this coordinate.
java.math.BigDecimal[]	getUncertaintyMinus() Gets the uncertainty in the negtive direction for each value of this coordinate.
java.math.BigDecimal[]	getUncertaintyPlus() Gets the uncertainty in the positive direction for each value of this coordinate.
java.math.BigDecimal[]	getValues() Gets the values of this coordinate.

Methods inherited from interface org.osid.binding.java.Coordinate

compareTo, equals, getClosestBound, getFarthestBound, getOuterBound, hashCode, isCloser, isExclusive, isFarther, isInclusive, isLarger, isSmaller

Methods inherited from interface org.osid.binding.java.OsidPrimitive

toString

Method Detail

getCoordinateType

Type getCoordinateType()

Gets the Type of this Coordinate which indicates the format of the coordinate data.

Returns:

the coordinate type

Compliance:

mandatory - This method must be implemented.

getDimensions

long getDimensions()

Gets the number of dimensions available in this coordinate.

Returns:

the number of dimensions

Compliance:

mandatory - This method must be implemented.

getValues

java.math.BigDecimal[] getValues()

Gets the values of this coordinate. The size of the returned array should equal getDimensions().

Returns:

the coordinate values

Compliance:

mandatory - This method must be implemented.

definesUncertainty

boolean definesUncertainty()

Tests if uncertainty is defined for this heading.

Returns:

true if uncertainty is defined, false otherwise

Compliance:

mandatory - This method must be implemented.

getUncertaintyMinus

java.math.BigDecimal[] getUncertaintyMinus()

Gets the uncertainty in the negtive direction for each value of this coordinate. The size of the returned array is typically one less than getDimensions().

Returns:

the negative uncertainty values

Compliance:

mandatory - This method must be implemented.

getUncertaintyPlus

java.math.BigDecimal[] getUncertaintyPlus()

Gets the uncertainty in the positive direction for each value of this coordinate. The size of the returned array is typically one less than getDimensions().

Returns:

the positive uncertainty values

Compliance:

mandatory - This method must be implemented.