Class: Geokit::Geocoders::Geocoder
- Inherits:
-
Object
- Object
- Geokit::Geocoders::Geocoder
- Defined in:
- lib/geokit/geocoders.rb
Overview
The Geocoder base class which defines the interface to be used by all other geocoders.
Direct Known Subclasses
CaGeocoder, FCCGeocoder, GeoPluginGeocoder, GeonamesGeocoder, GoogleGeocoder, GoogleGeocoder3, IpGeocoder, MultiGeocoder, UsGeocoder, YahooGeocoder
Class Method Summary collapse
-
.call_geocoder_service(url) ⇒ Object
Call the geocoder service using the timeout if configured.
-
.do_reverse_geocode(latlng) ⇒ Object
Not all geocoders can do reverse geocoding.
-
.geocode(address, options = {}) ⇒ Object
Main method which calls the do_geocode template method which subclasses are responsible for implementing.
-
.reverse_geocode(latlng) ⇒ Object
Main method which calls the do_reverse_geocode template method which subclasses are responsible for implementing.
Class Method Details
.call_geocoder_service(url) ⇒ Object
Call the geocoder service using the timeout if configured.
141 142 143 144 145 146 |
# File 'lib/geokit/geocoders.rb', line 141 def self.call_geocoder_service(url) Timeout::timeout(Geokit::Geocoders::request_timeout) { return self.do_get(url) } if Geokit::Geocoders::request_timeout return self.do_get(url) rescue TimeoutError return nil end |
.do_reverse_geocode(latlng) ⇒ Object
Not all geocoders can do reverse geocoding. So, unless the subclass explicitly overrides this method, a call to reverse_geocode will return an empty GeoLoc. If you happen to be using MultiGeocoder, this will cause it to failover to the next geocoder, which will hopefully be one which supports reverse geocoding.
151 152 153 |
# File 'lib/geokit/geocoders.rb', line 151 def self.do_reverse_geocode(latlng) return GeoLoc.new end |
.geocode(address, options = {}) ⇒ Object
Main method which calls the do_geocode template method which subclasses are responsible for implementing. Returns a populated GeoLoc or an empty one with a failed success code.
128 129 130 131 |
# File 'lib/geokit/geocoders.rb', line 128 def self.geocode(address, = {}) res = do_geocode(address, ) return res.nil? ? GeoLoc.new : res end |
.reverse_geocode(latlng) ⇒ Object
Main method which calls the do_reverse_geocode template method which subclasses are responsible for implementing. Returns a populated GeoLoc or an empty one with a failed success code.
135 136 137 138 |
# File 'lib/geokit/geocoders.rb', line 135 def self.reverse_geocode(latlng) res = do_reverse_geocode(latlng) return res.success? ? res : GeoLoc.new end |