openlr.map.loader
Interface OpenLRMapLoader


public interface OpenLRMapLoader

The interface OpenLRMapLoader defines methods which needs to be implemented in order to provide a new map to be shown in an application. The map loader implementation is aware of the underlying layout of the map data and makes this data available through this map loader interface and the OpenLR map interface. An implementation of the map loader interface needs to be registered as a service so that an application is able to use it during runtime. The implementation needs to be in the class path and will be found at runtime automatically. All required classes must be packaged into a jar-file including a file named META-INF/services/openlr.map.loader.OpenLRMapLoader The content of this text file is the fully qualified name of the map loader interface implementation.

OpenLR is a trade mark of TomTom International B.V.

email: software@openlr.org

Author:
TomTom International B.V.

Method Summary
 String getDescription()
          Gets the description of the map loader.
 String getMapDescriptor()
          Gets the map descriptor.
 String getName()
          Gets the name of the map loader.
 int getNumberOfParams()
          Gets the number of parameter (required and optional) used by this map loader.
 Collection<MapLoadParameter> getParameter()
          Gets the parameter (required and optional) used by this map loader .
 MapDatabase load(Collection<MapLoadParameter> params)
          Load the map database and return it using parameters.
 

Method Detail

load

MapDatabase load(Collection<MapLoadParameter> params)
                 throws OpenLRMapLoaderException
Load the map database and return it using parameters.

Parameters:
params - the parameters
Returns:
the map database
Throws:
OpenLRMapLoaderException - if loading the map failed

getParameter

Collection<MapLoadParameter> getParameter()
Gets the parameter (required and optional) used by this map loader .

Returns:
the parameter

getNumberOfParams

int getNumberOfParams()
Gets the number of parameter (required and optional) used by this map loader.

Returns:
the number of parameter

getDescription

String getDescription()
Gets the description of the map loader.

Returns:
the description

getName

String getName()
Gets the name of the map loader. The name should be unique and identify this map loader.

Returns:
the name of the map loader

getMapDescriptor

String getMapDescriptor()
Gets the map descriptor. This string describes the map being loaded by the map loader. It should include the location of the map (e.g. in the file system) and the parameters used for loading the map data. If no map has been loaded the string should be null.

Returns:
the map descriptor


Copyright © 2013 TomTom International B.V.. All Rights Reserved.