Package org.osid.mapping

The Open Service Interface Definitions for the org.osid.mapping service.

See: Description

Interface Summary

Interface	Description
Coordinate	A coordinate represents a position.
CoordinateList	Like all OsidLists, CoordinateList provides a means for accessing Coordinate elements sequentially either one at a time or many at a time.
Distance	A distance.
Heading	A heading represents a direction.
Location	A Location represents a location in a Map.
LocationAdjacencySession	This session defines methods to traverse through a map.
LocationAdminSession	This session creates, updates, and deletes Locations.
LocationForm	This is the form for creating and updating Locations.
LocationHierarchyDesignSession	This session defines methods for managing a hierarchy of Location objects.
LocationHierarchySession	This session defines methods for traversing a hierarchy of Location objects.
LocationList	Like all OsidLists, LocationList provides a means for accessing Location elements sequentially either one at a time or many at a time.
LocationLookupSession	This session defines methods for retrieving locations.
LocationMapAssignmentSession	This session provides methods to re-assign Locations to Map objects A Location may appear in multiple Map objects and removing the last reference to a Location is the equivalent of deleting it.
LocationMapSession	This session provides methods to retrieve Location to Map locations.
LocationNode	This interface is a container for a partial hierarchy retrieval.
LocationNodeList	Like all OsidLists, LocationNodeList provides a means for accessing LocationNode elements sequentially either one at a time or many at a time.
LocationNotificationSession	This session defines methods to receive notifications on adds/changes to Location objects in this Map.
LocationQuery	This is the query for searching locations.
LocationQueryInspector	This is the query inspector for searching locations.
LocationQuerySession	This session provides methods for searching among Location objects.
LocationReceiver	The location receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted locations.
LocationSearch	The search interface for governing location searches.
LocationSearchOrder	An interface for specifying the ordering of search results.
LocationSearchResults	This interface provides a means to capture results of a search.
LocationSearchSession	This session provides methods for searching among Location objects.
LocationSmartMapSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
LocationSpatialSession	This session defines methods for retrieving locations through spatial queries.
Map	A Map represents a collection of locations and paths.
MapAdminSession	This session creates, updates, and deletes Maps.
MapForm	This is the form for creating and updating maps.
MapHierarchyDesignSession	This session defines methods for managing a hierarchy of Map objects.
MapHierarchySession	This session defines methods for traversing a hierarchy of Map objects.
MapList	Like all OsidLists, MapList provides a means for accessing Map elements sequentially either one at a time or many at a time.
MapLookupSession	This session provides methods for retrieving Map objects.
MapNode	This interface is a container for a partial hierarchy retrieval.
MapNodeList	Like all OsidLists, MapNodeList provides a means for accessing MapNode elements sequentially either one at a time or many at a time.
MapNotificationSession	This session defines methods to receive notifications on adds/changes to Map objects.
MappingManager	The mapping manager provides access to mapping sessions and provides interoperability tests for various aspects of this service.
MappingProfile	The mapping profile describes the interoperability among mapping services.
MappingProxyManager	The mapping proxy manager provides access to mapping sessions and provides interoperability tests for various aspects of this service.
MapQuery	This is the query for searching maps.
MapQueryInspector	This is the query inspector for searching maps.
MapQuerySession	This session provides methods for searching among Map objects.
MapReceiver	The map receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Map objects.
MapSearch	The search interface for governing map searches.
MapSearchOrder	An interface for specifying the ordering of search results.
MapSearchResults	This interface provides a means to capture results of a search.
MapSearchSession	This session provides methods for searching among Map objects.
MyLocationSession	This session defines methods to route between locations.
ResourceLocation	This interface defines a resource at a location.
ResourceLocationList	Like all OsidLists, ResourceLocationList provides a means for accessing ResourceLocation elements sequentially either one at a time or many at a time.
ResourceLocationNotificationSession	This session defines methods to receive notifications on adds/changes to resources locations in this Map.
ResourceLocationReceiver	The resource location receiver is the consumer supplied interface for receiving notifications pertaining to location changes of resources.
ResourceLocationSession	This session defines methods to look up resources on a map.
ResourceLocationUpdateSession	This session defines update positions of resources.
ResourcePositionNotificationSession	This session defines methods to receive notifications on adds/changes to resource positions in this Map.
ResourcePositionReceiver	The resource location receiver is the consumer supplied interface for receiving notifications pertaining to position changes of resources.
SpatialUnit	A spatial unit can represent a single position or an area constructed of multiple positions or shapes.
SpatialUnitList	Like all OsidLists, SpatialUnitList provides a means for accessing SpatialUnit elements sequentially either one at a time or many at a time.
Speed	A speed is a distance traveled over a unit of time.

Enum Summary

Enum	Description
DistanceResolution	This enumeration contains the possible length units.

Package org.osid.mapping Description

The Open Service Interface Definitions for the org.osid.mapping service.

The Mapping OSID provides a means for managing inventories of places and performing a variety of mapping operations.

Locations

One aspect of the Mapping OSID provides references to location places used in other OSIDs. A Location may include a spatial coordinate or defined boundary described in a SpatialUnit. Additional sessions provide a means to easily look up locations by Coordinate or arbitrary SpatialUnit as well as to traverse locations through lookups of adjacent Locations.

Locations may be structured in hierarchies to convey hierarchical relationships. A room may be located inside a building, within a city within a state.

Primitives

The data interfaces for Coordinates and SpatialUnits are defined through their respective Types to allow for any kind of coordinate or spatial system. A definition for distance resolution is also provided to capture an extremely wide array of unit values. Distance, Coordinate, Heading, and SpatialUnit appear to the OSID as complex primitive interfaces which are constructed by the consumer in order to fulfill the interface contracts. It is required that the consumer and provider agree on the coordinate domain and spatial unit types through testing of the Type support.

Resource Tracking

Resources may be tracked spatially. Sessions are available to query and place Resources at specific Locations and Coordinates, and receive notifications to changes in their locations.

Map Cataloging

Locations may be organuzed in hierarchical Maps that offer a means of federation or layering of map data.

Sub Packages

The Mapping OSID includes a Mapping Route OSID for creating and navigating Routes, a Mapping Path OSID for querying and designing physical Paths and a Mapping Batch OSID for managing locations in bulk.

Copyright © 2010 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may nodify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.