Parent

Geokit::Geocoders::Geocoder

The Geocoder base class which defines the interface to be used by all other geocoders.

Public Class Methods

call_geocoder_service(url) click to toggle source

Call the geocoder service using the timeout if configured.

# File lib/geokit/geocoders.rb, line 146
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) click to toggle source

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.

# File lib/geokit/geocoders.rb, line 156
def self.do_reverse_geocode(latlng)
  return GeoLoc.new
end
geocode(address, options = {}) click to toggle source

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.

# File lib/geokit/geocoders.rb, line 133
def self.geocode(address, options = {}) 
  res = do_geocode(address, options)
  return res.nil? ? GeoLoc.new : res
end
reverse_geocode(latlng) click to toggle source

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.

# File lib/geokit/geocoders.rb, line 140
def self.reverse_geocode(latlng)
  res = do_reverse_geocode(latlng)
  return res.success? ? res : GeoLoc.new        
end

Protected Class Methods

logger() click to toggle source
# File lib/geokit/geocoders.rb, line 162
def self.logger() 
  Geokit::Geocoders::logger
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.