Oskari-Routing

Oskari-Routing provides in-application route calculation on Oskari platform. Oskari-Routing is submit entry to Oskari Challenge 2015.

Oskari-Routing is a collection of enhancements both in the backend and in the front-end of Oskari. See Oskari-Routing front end.

Video on Oskari-Routing in action

Demo Setup

In order to get Oskari-Routing to work some setup is required.

First setup Oskari server as instructed in Oskari.org documentation.

1. Setup pgRouting in the database

Even though Oskari-Routing implements proprietary A* Algorithm it uses pgRouting to construct graph representation from given road link data.

Oskari-Routing also provides support for pgRouting A* Algorithm that can be used on side with the proprietary algorithm.

Install pgRouting from http://pgrouting.org/. Tested on pgRouting 2.0.0
Create pgRouting extension in oskari database by running the following as a db user that has superuser rights:

\c oskaridb
create extension if not exists pgrouting;

2. Acquire road link data that can be used for routing

As an example we are going to use road link data of downtown Helsinki for route calculation. Data is fetched as a shape file from National Land Survey of Finland database.

At the root folder run the script to fetch road links from NLS: ./fetch-roadlinks-hki.sh This will create roadlinks-hki.shp.zip zipped shape file that contains road links of downtown Helsinki area.
Unzip the zipped shape file to a new directory:

mkdir roadlinks-hki
mv roadlinks-hki.shp.zip roadlinks-hki
cd roadlinks-hki
unzip roadlinks-hki.shp.zip

3. Import road link data to Oskari database

Create SQL script from shape file by running following in the directory to which road link shape file was extracted:
shp2pgsql -s 3067 -g geom -I -S -W LATIN1 tieviiva.shp public.hkiroads > hkiroads.sql
This will output hkiroads.sql - file to the directory in which the command is executed.
The parameters depend on the road link data in question. These parameters are tailored for the data acquired in the previous step and are explained below:
- -s 3067 -> Use specified projection identified by srid (ETRS89 / ETRS-TM35FIN)
- -g geom -> Write road link geometry to geom column
- -I -> Create spatial index on the geometry
- -S -> Generate simple geometries (LineString instead of MultiLineString)
- -W LATIN1 -> Use correct character encoding
Import road links from hkiroads.sql-file to PostgreSQL as oskari user: psql -d oskaridb -U oskari -f hkiroads.sql -W
Here its assumed that Oskari uses db by role oskari
In case of error: ERROR: operator class "gist_geometry_ops" does not exist for access method "gist" Import legacy_gist.sql to PostgreSQL and import hkiroads.sql-file again.

4. Setup Oskari application

Make sure that the oskari user is the owner of the schema in which hkiroads table exists. Without this pgRouting setup functions won't work and graph cannot be built.
In our case run the following as the schema public owner:
alter schema public owner to oskari;
Create functions required for Oskari-Routing. This step has to be completed manually since Oskari sql parser does not support definition of functions.
Run the following in root directory:
psql -d oskaridb -U oskari -f content-resources/src/main/resources/sql/PostgreSQL/create-pgrouting-functions.sql
Replace oskari with the user role Oskari uses to connecto to database
Setup test application and create graph with pgRouting for route calculation.
Run the following in the content-resources directory:
mvn compile exec:java -Doskari.dropdb=true -Doskari.setup=oskari-routing -Ddb.username=oskari -Ddb.password=<oskaripasswd>

5. Run Demo

Now everything should be ready for demo.

Launch Oskari backend:
Run following in standalone-jetty directory:
mvn compile exec:java -Ddb.username=oskari -Ddb.password=<oskaripasswd>
Direct your browser to:
http://localhost:2373/
You should see Routing-tile on the left which you can select to do route calculations

As said, Oskari-Routing is a collection of improvements to Oskari to enable in-application routing. It contains following:

Routing bundle

Bundle that implements user interface for route calculation. See Oskari-Routing front end for more info.

GeoJSON plugin

Bundle that allows rendering of GeoJSON content on the Oskari front-end. See Oskari-Routing front end for more info.

control-routing

Backend module that handles incoming route calculation requests from front-end, parses front-end parameters, calls service-routing and transforms service-routing output to GeoJSON for delivering to front-end.

service-routing

Backend module that implements proprietary A* Algorithm and supports A* Algorithm of pgRouting.

At the moment the proprietary A* Algorithm can handle one-directional road links whereas pgRouting can not.

On the other hand pgRouting A* Algorithm is considerable faster than the proprietary A* Algorithm.

Proprietary A* Algorithm could be sped up considerably by implementing fi.nls.oskari.routing.Graph that would less database queries than the fi.nls.oskari.routing.PgRoutingTableGraph that the A* Algorithm uses at the moment.

Currently the routing algorithms route from existing node to an existing node. Start and end node are selected according to which node is closest to the coordinates provided. This could be improved so that routing can start from any point on edge and end on any point on edge.

Miscellaneous enhancements

Database enhancements needed for routing
pgRouting integration
Bug fix to content-resources module so that user can override db user and password on command line.

TODO:

Allow definition of road link table name in configuration
Improve A* Algorithm performance by reducing the amount of database queries
Allow routing from anywhere on edge (currently route calculation always starts and ends from/to the closest node)
Support one-way road links with pgRouting algorithms
Support for remaining pgRouting algorithms
Allow dynamic variables in route calculation (such as traffic conditions)

License

License MIT (included LICENSE-MIT.txt)

uhef / Oskari-Routing