kaos.spatial
Interface SpatialDatabase

All Known Implementing Classes:

SpatialReasoner

public interface SpatialDatabase

This interface defines methods allowing for manipulation of spatial database information.

Method Summary

Location3D	getObjectLocation(java.lang.String objectID) This method allows to obtain location of a known spatial object.
java.util.Set	getObjectOntologicalTypes(java.lang.String objectID) This method allows to obtain location of a known spatial object.
Orientation3D	getObjectOrientation(java.lang.String objectID) This method allows to obtain orientation of a known spatial object.
Block3D	getOccupiedSpace(java.lang.String objectID) This method allows to obtain aproximation of the occupied space of a known spatial object.
void	registerSpatialObject(java.lang.String objectID, java.util.Set objectOntologyTypes, Location3D objectLocation, Orientation3D objectOrientation, Block3D objectOccupedSpace) This method allows to add information about a new spatial object.
void	updateSpatialObject(java.lang.String objectID, Location3D objectLocation, Orientation3D objectOrientation, Block3D objectOccupedSpace) This method allows to modify information about a known spatial object.

Method Detail

registerSpatialObject

void registerSpatialObject(java.lang.String objectID,
                           java.util.Set objectOntologyTypes,
                           Location3D objectLocation,
                           Orientation3D objectOrientation,
                           Block3D objectOccupedSpace)
                           throws AlreadyRegisteredException

This method allows to add information about a new spatial object. The description about the object contains information about its: ontological type (e.g. Robot, Craft, Area. etc.), location as 3 coordinates (xyz), orientation as 3 radiuses (from xyz axis) and the minimal space block occupied by the object

Parameters:

objectID - - id of the registered object

objectOntologyType - - set of @see java.net.URI in the OWL ontology file to the definition of the object class

objectLocation - - initial location of the object represnted as @see Location3D

objectOrientation - - initial orientation of the object represnted as @see Orientation3D

objectOccupedSpace - - initial space occupied by the object represnted as @see Block3D

Throws:

AlreadyRegisteredException - when the object is already registered in the spatial database

updateSpatialObject

void updateSpatialObject(java.lang.String objectID,
                         Location3D objectLocation,
                         Orientation3D objectOrientation,
                         Block3D objectOccupedSpace)
                         throws NotRegisteredException

This method allows to modify information about a known spatial object. The value null of a particular parameter is interpreted as information that the corresponding spatial property of the object has not changed.

Parameters:

objectID - - id of the updated object

objectLocation - - new location of the object represnted as @see Location3D

objectOrientation - - new orientation of the object represnted as @see Orientation3D

objectOccupedSpace - - new space occupied by the object represnted as @see Block3D

Throws:

NotRegisteredException - when the object is not registered in the spatial database

getObjectOntologicalTypes

java.util.Set getObjectOntologicalTypes(java.lang.String objectID)
                                        throws NotRegisteredException

This method allows to obtain location of a known spatial object.

Parameters:

objectID - - id of the object

Returns:

Set - set of @see java.net.URI in the OWL ontology file to the definition of the object class

Throws:

NotRegisteredException - when the object is not registered in the spatial database

getObjectLocation

Location3D getObjectLocation(java.lang.String objectID)
                             throws NotRegisteredException

This method allows to obtain location of a known spatial object.

Parameters:

objectID - - id of the object return @see Location3D - object containg location coordinates as xyz

Throws:

NotRegisteredException - when the object is not registered in the spatial database

getObjectOrientation

Orientation3D getObjectOrientation(java.lang.String objectID)
                                   throws NotRegisteredException

This method allows to obtain orientation of a known spatial object.

Parameters:

objectID - - id of the object return @see Orientation3D - object containg orientation as xyz radiuses

Throws:

NotRegisteredException - when the object is not registered in the spatial database

getOccupiedSpace

Block3D getOccupiedSpace(java.lang.String objectID)
                         throws NotRegisteredException

This method allows to obtain aproximation of the occupied space of a known spatial object.

Parameters:

objectID - - id of the object return @see Block3D - object containg inforationas about an occupied space as a 3d block

Throws:

NotRegisteredException - when the object is not registered in the spatial database