org.osid.mapping

Interface SpatialUnit

All Superinterfaces:

java.lang.Comparable<SpatialUnit>, Extensible, OsidPrimitive, java.io.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

Methods

Modifier and Type	Method and 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 org.osid.Extensible

getRecordTypes, hasRecordType

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

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

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

toString

Method Detail

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.