Skip to content
Call many geocoders
Perl
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Fix reverse_coding argument parser Oct 9, 2019
lib/Geo/Coder
t
.appveyor.yml
.gitignore
.tachikoma.yml Added tachikoma support Dec 22, 2016
.travis.yml Move to latest Travis template Aug 20, 2019
Changes
LICENSE Initial commit Dec 21, 2016
MANIFEST
Makefile.PL Warn when on-line testing all automatically disabled Oct 10, 2019
README
README.md
ignore.txt Started mapping other fields May 15, 2017

README.md

Linux Build Status Windows Build status Coverage Status CPAN

NAME

Geo::Coder::List - Call many Geo-Coders

VERSION

Version 0.26

SYNOPSIS

Geo::Coder::All and Geo::Coder::Many are great routines but neither quite does what I want. This module's primary use is to allow many backends to be used by HTML::GoogleMaps::V3

SUBROUTINES/METHODS

new

Creates a Geo::Coder::List object.

Takes an optional argument 'cache' which takes an cache object that supports get() and set() methods. The licences of some geo coders, such as Google, specifically prohibit caching API calls, so be careful to only use with those services that allow it.

use Geo::Coder::List;
use CHI;

my $geocoder->new(cache => CHI->new(driver => 'Memory', global => 1));

push

Add an encoder to list of encoders.

use Geo::Coder::List;
use Geo::Coder::GooglePlaces;
# ...
my $list = Geo::Coder::List->new()->push(Geo::Coder::GooglePlaces->new());

Different encoders can be preferred for different locations. For example this code uses geocode.ca for Canada and US addresses, and OpenStreetMap for other places:

my $geo_coderlist = Geo::Coder::List->new()
    ->push({ regex => qr/(Canada|USA|United States)$/, geocoder => Geo::Coder::CA->new() })
    ->push(Geo::Coder::OSM->new());

# Uses Geo::Coder::CA, and if that fails uses Geo::Coder::OSM
my $location = $geo_coderlist->geocode(location => '1600 Pennsylvania Ave NW, Washington DC, USA');
# Only uses Geo::Coder::OSM
if($location = $geo_coderlist->geocode('10 Downing St, London, UK')) {
    print 'The prime minister lives at co-ordinates ',
        $location->{geometry}{location}{lat}, ',',
        $location->{geometry}{location}{lng}, "\n";
}

# It is also possible to limit the number of enquires used by a particular encoder
$geo_coderlist->push({ geocoder => Geo::Coder::GooglePlaces->new(key => '1234'), limit => 100) });

geocode

Runs geocode on all of the loaded drivers. See Geo::Coder::GooglePlaces::V3 for an explanation

The name of the Geo-Coder that gave the result is put into the geocode element of the return value, if the value was retrieved from the cache the value will be undefined.

if(defined($location->{'geocoder'})) {
    print 'Location information retrieved using ', $location->{'geocoder'}, "\n";
}

ua

Accessor method to set the UserAgent object used internally by each of the Geo-Coders. You can call env_proxy for example, to get the proxy information from environment variables:

my $geocoder_list = Geo::Coder::List->new();
my $ua = LWP::UserAgent->new();
$ua->env_proxy(1);
$geocoder_list->ua($ua);

Note that unlike Geo::Coders, there is no read method, since that would be pointless.

reverse_geocode

Similar to geocode except it expects a latitude/longitude parameter.

print $geocoder_list->reverse_geocode(latlng => '37.778907,-122.39732');

log

Returns the log of events to help you debug failures, optimize lookup order and fix quota breakage.

my @log = @{$geocoderlist->log()};

flush

Clear the log.

AUTHOR

Nigel Horne, <njh at bandsman.co.uk>

BUGS

Please report any bugs or feature requests to bug-geo-coder-list at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Geo-Coder-List. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

reverse_geocode() doesn't update the logger. reverse_geocode() should support Geo::Location::Point objects.

SEE ALSO

Geo::Coder::All Geo::Coder::GooglePlaces Geo::Coder::Many

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Geo::Coder::List

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2016-2019 Nigel Horne.

This program is released under the following licence: GPL2

You can’t perform that action at this time.