tomtom-international / openlr

Reference implementation of OpenLR. A map agnostic, dynamic location referencing method.
Other
90 stars 30 forks source link

OpenLR

Codacy Badge Build Status Coverage Status [License]() Release

Installation

The project can be built with Maven and Java 8.

To build all the modules go to the project folder:

mvn clean install

To build modules individually go to module folder:

mvn clean install

Usage

There are 9 modules:

encoder

The encoder package holds the reference implementation for the OpenLR encoder. It takes a (map-dependent) location as input and generates a corresponding (map-agnostic) location reference. This package uses the OpenLR map package and the OpenLR data package.

map

The map package consists of the map interface and map tools being used by the OpenLR encoder and decoder. The user of this package needs to implement the required methods and needs to translate the internal data structure to the OpenLR map interface.

maploader-tt-sqlite

This library provides an access layer which enables OpenLR to use TomTom Digital Maps in SQLite Format.

decoder

The decoder package holds the reference implementation for the OpenLR decoder. It takes a (map-agnostic) location reference as input and finds back a corresponding (map-dependent) location reference. This package uses the OpenLR map package and the OpenLR binary package.

data

The OpenLR data package comprises interfaces for OpenLR location references and also interfaces for encoding and decoding the internal data into a defined physical format and the other way round.

xml

OpenLR XML physical format.

binary

This package consists of classes for reading and writing binary location. reference data. The OpenLR encoder uses this package to create a binary representation of a location reference. The OpenLR decoder uses this package to receive and decode binary location reference data.

datex2

This package deals with Datex2 data.