openlr.encoder

Interface LRDatabase

public interface LRDatabase

The Interface LRDatabase defines methods for a database storing locations and their location references. This database shall avoid encoding the same location twice. It is assumed that a fast database implementation will speed up the response time of encoding a location if the location reference is already known. The database shall be able to store a pre-defined number of location / location reference pairs in its cache.

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

email: software@openlr.org

Author:

TomTom International B.V.

Method Summary

Modifier and Type	Method and Description
void	clear() Clear the database cache.
boolean	containsLR(Location loc) Checks if the location is already stored in the database.
int	getCacheSize() Gets the maximum cache size.
int	getCurrentNrEntries() Gets the current number of entries in the database.
LocationReferenceHolder	getResult(Location loc) Gets the location reference for the location
void	storeResult(Location loc, LocationReferenceHolder locref) Store the location and its location reference

Method Detail

getCacheSize

int getCacheSize()

Gets the maximum cache size.

Returns:

the maximum cache size

getCurrentNrEntries

int getCurrentNrEntries()

Gets the current number of entries in the database.

Returns:

the current number of entries in the database

clear

void clear()

Clear the database cache.

containsLR

boolean containsLR(Location loc)

Checks if the location is already stored in the database.

Parameters:

loc - the location

Returns:

true, if the location is stored in the database

getResult

LocationReferenceHolder getResult(Location loc)

Gets the location reference for the location

Parameters:

loc - the location

Returns:

the location reference

storeResult

void storeResult(Location loc,
                 LocationReferenceHolder locref)

Store the location and its location reference

Parameters:

loc - the location

locref - the location reference