Interface Coordinate

All Superinterfaces:

Comparable<Coordinate>, Coordinate, OsidPrimitive, OsidPrimitive, Serializable

public interface Coordinate
extends OsidPrimitive, Coordinate

A coordinate represents a position.

Method Summary

Modifier and Type	Method	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.
BigDecimal[]	getUncertaintyMinus()	Gets the uncertainty in the negtive direction for each value of this coordinate.
BigDecimal[]	getUncertaintyPlus()	Gets the uncertainty in the positive direction for each value of this coordinate.
BigDecimal[]	getValues()	Gets the values of this coordinate.

Methods inherited from interface Coordinate

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

Modifier and Type	Method	Description
int	compareTo(Coordinate coordinate)	Compares this coordinate with the specified Coordinate to determine the natural order.
boolean	equals(Object obj)	Determines if the given Coordinate is equal to this one.
Coordinate	getClosestBound()	Gets the closest bound of the coordinate.
Coordinate	getFarthestBound()	Gets the farthest bound of the coordinate.
SpatialUnit	getOuterBound()	Gets the outer bound of the coordinate.
int	hashCode()	Returns a hash code value for this Coordinate.
boolean	isCloser(Coordinate one, Coordinate another)	Tests if one Coordinate is closer to origin than another to this Coordinate.
boolean	isExclusive(Coordinate coordinate)	Tests if this Coordinate, as specified by its uncertainty, does not overlap the given Coordinate.
boolean	isFarther(Coordinate one, Coordinate another)	Tests if one Coordinate is farther from origin than another from this Coordinate.
boolean	isInclusive(Coordinate coordinate)	Tests if this Coordinate, as specified by its uncertainty, completely includes the given Coordinate ranged by its uncertainty.
boolean	isLarger(Coordinate coordinate)	Tests if this Coordinate is greater in area than the given Coordinate.
boolean	isSmaller(Coordinate coordinate)	Tests if this Coordinate is less in area than the given Coordinate.

Methods inherited from interface OsidPrimitive

toString

Modifier and Type	Method	Description
String	toString()	Returns a string representation of this OsidPrimitive.

Method Details

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

BigDecimal[] getValues()

Gets the values of this coordinate. The size of the returned array equals 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

BigDecimal[] getUncertaintyMinus()

Gets the uncertainty in the negtive direction for each value of this coordinate. The size of the returned array equals getDimensions() .

Returns:

the negative uncertainty values

Compliance:

mandatory - This method must be implemented.

getUncertaintyPlus

BigDecimal[] getUncertaintyPlus()

Gets the uncertainty in the positive direction for each value of this coordinate. The size of the returned array equals getDimensions() .

Returns:

the positive uncertainty values

Compliance:

mandatory - This method must be implemented.