OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.SpatialUnit
Implementsosid.OsidPrimitive
osid.Extensible
Description

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.

MethodgetCenterCoordinate
Description

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

Returnosid.mapping.Coordinatethe center coordinate
CompliancemandatoryThis method must be implemented.
MethodgetBoundingCoordinates
Description

Gets a list of bounding coordinates of this spatial unit.

Returnosid.mapping.CoordinateListthe bounding coordinates
CompliancemandatoryThis method must be implemented.
MethodgetSpatialUnitRecord
Description

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 .

Parametersosid.type.TypespatialUnitRecordTypethe type of spatial unit record to retrieve
Returnosid.mapping.records.SpatialUnitRecordthe spatial unit record
ErrorsNULL_ARGUMENT spatialUnitRecordType is null
UNSUPPORTED hasRecordType(spatialUnitRecordType) is false
CompliancemandatoryThis method must be implemented.