com.kuka.nav.data
Interface LocationData

public interface LocationData

Access methods for local locations data source.

Method Summary

Location	get(int locationId) Returns a specific location with the given id in the data source.
Location	get(int mapId, String locationName) Returns a specific location with the given name associated to the map with the given id in the data source.
Location	get(String mapName, String locationName) Returns a specific location with the given name associated to the map with the given name in the data source.
Collection<Location>	getAll() Returns a list of all locations.
Collection<Location>	getAllOnMap(int mapId) Returns the list of locations associated to map with the given id in the data source.
Collection<Location>	getAllOnMap(String mapName) Returns the list of locations associated to the map with the given name in the data source.

Method Detail

getAll

Collection<Location> getAll()

Returns a list of all locations.

Returns:

List of all locations known to the data source.

getAllOnMap

Collection<Location> getAllOnMap(int mapId)

Returns the list of locations associated to map with the given id in the data source.

Parameters:

mapId - The id of the map for which the locations are to be returned.

Returns:

List of locations associated to the given map id.

getAllOnMap

Collection<Location> getAllOnMap(String mapName)

Returns the list of locations associated to the map with the given name in the data source.

Parameters:

mapName - The name of the map for which the locations are to be returned.

Returns:

List of locations associated to the given map id.

get

Location get(int locationId)

Returns a specific location with the given id in the data source. If the location does not exist null is returned.

Parameters:

locationId - the id of the location to be returned

Returns:

the location or null if the location does not exist

get

Location get(int mapId,
             String locationName)

Returns a specific location with the given name associated to the map with the given id in the data source. If the location does not exist null is returned.

Parameters:

mapId - the id of the associated map

locationName - the name of the location to be returned

Returns:

the location or null if the location does not exist

get

Location get(String mapName,
             String locationName)

Returns a specific location with the given name associated to the map with the given name in the data source. If the location does not exist null is returned.

Parameters:

mapName - the name of the associated map

locationName - the name of the location to be returned

Returns:

the location or null if the location does not exist