Interface SpatialUnit

All Superinterfaces:

Comparable<SpatialUnit>, Extensible, OsidPrimitive, OsidPrimitive, Serializable, SpatialUnit

public interface SpatialUnit
extends OsidPrimitive, Extensible, SpatialUnit

A spatial unit can represent a single position or an area constructed of multiple positions or shapes. The data describing the spatial unit is defined in the record indicated by the record type.

Method Summary

Modifier and Type	Method	Description
CoordinateList	getBoundingCoordinates()	Gets a list of bounding coordinates of this spatial unit.
Coordinate	getCenterCoordinate()	Gets a single corrdinate to represent the center of this spatial unit.
SpatialUnitRecord	getSpatialUnitRecord(Type spatialUnitRecordType)	Gets the spatial unit record corresponding to the given SpatialUnit record Type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidPrimitive

toString

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

Methods inherited from interface SpatialUnit

compareTo, equals, getInnerBound, getOuterBound, hashCode, isCloser, isExclusive, isFarther, isInclusive, isLarger, isSmaller

Modifier and Type	Method	Description
int	compareTo(SpatialUnit unit)	Compares this spatial unit with the specified SpatialUnit to determine the natural order.
boolean	equals(Object obj)	Determines if the given SpatialUnit is equal to this one.
SpatialUnit	getInnerBound()	Gets the lower bound of the spatial unit.
SpatialUnit	getOuterBound()	Gets the upper bound of the spatial unit.
int	hashCode()	Returns a hash code value for this SpatialUnit based on the types, values, granularity, and uncertainties.
boolean	isCloser(SpatialUnit one, SpatialUnit another)	Tests if one SpatialUnit is closer than another to this SpatialUnit.
boolean	isExclusive(SpatialUnit unit)	Tests if this SpatialUnit, as specified by its uncertainty, does not overlap the given SpatialUnit.
boolean	isFarther(SpatialUnit one, SpatialUnit another)	Tests if one SpatialUnit is farther than another from this SpatialUnit.
boolean	isInclusive(SpatialUnit unit)	Tests if the SpatialUnit, as specified by its uncertainty, completely includes the given SpatialUnit ranged by its uncertainty.
boolean	isLarger(SpatialUnit unit)	Tests if this SpatialUnit is greater than the given SpatialUnit.
boolean	isSmaller(SpatialUnit unit)	Tests if this SpatialUnit is less than the given SpatialUnit.

Method Details

getCenterCoordinate

Coordinate getCenterCoordinate()

Gets a single corrdinate to represent the center of this spatial unit.

Returns:

the center coordinate

Compliance:

mandatory - This method must be implemented.

getBoundingCoordinates

CoordinateList getBoundingCoordinates()

Gets a list of bounding coordinates of this spatial unit.

Returns:

the bounding coordinates

Compliance:

mandatory - This method must be implemented.

getSpatialUnitRecord

SpatialUnitRecord getSpatialUnitRecord(Type spatialUnitRecordType)

Gets the spatial unit record corresponding to the given SpatialUnit record Type. The spatialUnitRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(spatialUnitRecordType) is true.

Parameters:

spatialUnitRecordType - the type of spatial unit record to retrieve

Returns:

the spatial unit record

Throws:

NullArgumentException - spatialUnitRecordType is null

UnsupportedException - hasRecordType(spatialUnitRecordType) is false

Compliance:

mandatory - This method must be implemented.