openlr.map.loader
Interface MapLoadParameter

All Superinterfaces:
Serializable

public interface MapLoadParameter
extends Serializable

The interface MapLoadParameter defines methods for the identification and the type of a parameter. Parameters are used by the map loader to e.g. detect the location of the map data and/or to identify a region to be loaded. They may be required or optional and each parameter has a type. The type is used to present a file load dialog, a directory load dialog or a single text field.

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

email: software@openlr.org

Author:
TomTom International B.V.

Nested Class Summary
static class MapLoadParameter.ParameterType
          The enum ParameterType defines the type of a parameter.
 
Method Summary
 String getDescription()
          Return the description of the parameter.
 int getIdentifier()
          Gets the identifier which uniquely identifies this parameter for a specific map loader.
 String getName()
          Gets the name of the parameter.
 MapLoadParameter.ParameterType getType()
          Gets the type of the parameter.
 String getValue()
          Gets the value of the parameter.
 boolean isRequired()
          Checks if this parameter is required.
 void setValue(String val)
          Sets the value of the parameter.
 

Method Detail

getType

MapLoadParameter.ParameterType getType()
Gets the type of the parameter. This type decides whether a file/directory load dialog or a single text field will be used in the map load parameter dialog.

Returns:
the parameter type

getName

String getName()
Gets the name of the parameter. This name will be used as a label in the map load parameter dialog and should be unique.

Returns:
the name

isRequired

boolean isRequired()
Checks if this parameter is required.

Returns:
true, if the parameter is required

getDescription

String getDescription()
Return the description of the parameter. This description will be used as a tooltip in the map load parameter dialog.

Returns:
the description

getIdentifier

int getIdentifier()
Gets the identifier which uniquely identifies this parameter for a specific map loader.

Returns:
the identifier

getValue

String getValue()
Gets the value of the parameter. If the value is not set the method shall return null.

Returns:
the value

setValue

void setValue(String val)
Sets the value of the parameter.

Parameters:
val - the new value


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