openlr.decoder

Interface LocationDatabase

public interface LocationDatabase

The Interface LocationDatabase defines methods for a database storing location references and their locations. This database shall avoid decoding the same location reference twice. It is assumed that a fast database implementation will speed up the response time of decoding a location reference if the location is already known. The database shall be able to store a pre-defined number of location reference / location 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(RawLocationReference locRef) Checks if the location reference is already stored in the database.
int	getCacheSize() Gets the maximum cache size.
int	getCurrentNrEntries() Gets the current number of entries in the database.
Location	getResult(RawLocationReference locRef) Gets the location for the location reference.
void	storeResult(RawLocationReference locRef, Location loc) 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(RawLocationReference locRef)

Checks if the location reference is already stored in the database.

Parameters:

locRef - the location reference

Returns:

true, if the location reference is stored in the database

getResult

Location getResult(RawLocationReference locRef)

Gets the location for the location reference. The method returns null if no Location is stored for the RawLocationReference

Parameters:

locRef - the location reference

Returns:

the location

storeResult

void storeResult(RawLocationReference locRef,
                 Location loc)

Store the location and its location reference

Parameters:

loc - the location

locRef - the location reference