com.kuka.nav.data
Interface MapZoneData

public interface MapZoneData

Access methods for map zone data source.

Method Summary

MapZone	get(int mapZoneId) Returns the map zone with the given id in the data source.
MapZone	get(int mapId, String mapZoneName) Returns the map zone with the given name associated to the map with the given id in the data source.
MapZone	get(String mapName, String mapZoneName) Returns the map zone with the given name associated to the map with the given name in the data source.
Collection<MapZone>	getAll() Returns a list with all the map zones in the data source.
Collection<MapZone>	getAllOnMap(int mapId) Returns a list with all the map zones associated to the map with the given id.
Collection<MapZone>	getAllOnMap(String mapName) Returns a list with all the map zones associated to the map with the given name.

Method Detail

getAll

Collection<MapZone> getAll()

Returns a list with all the map zones in the data source.

Returns:

a list with all the map zones. An empty list is returned if no zones are defined for the given map.

getAllOnMap

Collection<MapZone> getAllOnMap(int mapId)

Returns a list with all the map zones associated to the map with the given id.

Parameters:

mapId - the id of the map for which the zones are to be returned

Returns:

a list with all the map zones associated to the given map. An empty list is returned if no zones are defined for the given map.

getAllOnMap

Collection<MapZone> getAllOnMap(String mapName)

Returns a list with all the map zones associated to the map with the given name.

Parameters:

mapName - the name of the map for which the zones are to be returned

Returns:

a list with all the map zones associated to the given map. An empty list is returned if no zones are defined for the given map.

get

MapZone get(int mapZoneId)

Returns the map zone with the given id in the data source. If the map zone does not exist null is returned.

Parameters:

mapZoneId - the id of the map zone

Returns:

the map zone with the given id or null if the map zone does not exist

get

MapZone get(int mapId,
            String mapZoneName)

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

Parameters:

mapId - the id of the associated map

mapZoneName - the name of the map zone to be returned

Returns:

the map zone with the given name or null if the map zone does not exist

get

MapZone get(String mapName,
            String mapZoneName)

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

Parameters:

mapName - the name of the associated map

mapZoneName - the name of the map zone to be returned

Returns:

the map zone with the given name or null if the map zone does not exist