map_geocode_nominatim (3)

NAME

map::geocode::nominatim - Resolving geographical names with a Nominatim service

SYNOPSIS

package require Tcl 8.5

package require http

package require json

package require uri

package require snit

package require map::geocode::nominatim ?0.1?

::map::geocode::nominatim requestor ?-baseurl url? ?-callback callback? ?-error error callback?

$cmdprefix result

$cmdprefix errorstring

requestor search query

DESCRIPTION

This package provides a class for accessing geocoding services which implement the Nominatim interface (see References)

API

::map::geocode::nominatim requestor ?-baseurl url? ?-callback callback? ?-error error callback?

Creates a geocoding request object requestor, which will send its requests to the Nominatim server.

The result of the command is name.

OPTIONS

-baseurl url

The base URL of the Nominatim service. Default value is OpenStreetMap's service at nominatim.openstreetmap.org/search A possible free alternative is at open.mapquestapi.com//nominatim/v1/search

-callback cmdprefix

A command prefix to be invoked when search result become available. The default setting, active when nothing was specified on object creation, is to print the result (see below) to stdout. The result of the command prefix is ignored. Errors thrown by the command prefix are caught and cause the invokation of the error callback (see option -error below), with the error message as argument.

The signature of the command prefix is:

$cmdprefix result

The result is a list of dictionaries, containing one item per hit. Each dictionary will have the following entries:

place_id

The place ID (FIXME: what's this?)

licence

The data licence string

osm_type

The OSM type of the location

osm_id

FIXME

boundingbox

The coordinates of the bounding box (min and max latitude, min and max longitude)

lat

The location's latitude

lon

The location's longitude

display_name

the location's human readable name

class

FIXME

type

FIXME

icon

FIXME

-error cmdprefix

A command prefix to be invoked when encountering errors. Typically these are HTTP errors. The default setting, active when nothing was specified on object creation, is to print the errorstring (see below) to stderr. The result of the command prefix is ignored. Errors thrown by the command prefix are passed to higher levels.

The signature of the command prefix is:

$cmdprefix errorstring

METHODS

requestor search query

This method returns a list of dictionaries, one item per hit for the specified query.

REFERENCES

[1]

wiki.openstreetmap.org/wiki/Nominatim

[2]

open.mapquestapi.com/nominatim

KEYWORDS

geocoding, http, location, map, nominatim, server, url