class Geocoder extends AnyRef

Converts strings and addresses to latitude/longitude values.

Latitude/Longitude values can be queried with a formatted address. The Google Maps API is called using the values from the address and a com.koddi.geocoder.Result instance is returned.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Geocoder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Geocoder(apiUrl: String, apiKey: Option[String], parameters: Option[Parameters], responseParser: ResponseParser)

    apiUrl

    the api endpoint used to send requests to

    apiKey

    an optional key to use when making api requests

    parameters

    global parameters to apply to every request

    responseParser

    an XML parser used to deconstruct the API response

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def createURL(searchParam: String, searchValue: String): URL
    Attributes
    protected
  7. def doGetRequest(url: URL): Response
    Attributes
    protected
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def lookup(components: Seq[AbstractComponent]): Seq[Result]

    Query the Geocoder API using Component entities.

    Query the Geocoder API using Component entities.

    Components represent query parameters and are part of the Google Maps Geocing API. For simplicity predefined Component types are defined in com.koddi.geocoder.Component

  15. def lookup(latitude: Double, longitude: Double): Seq[Result]

    Lookups an address given a location entity.

    Lookups an address given a location entity.

    A request to the Google Maps API is made to obtain the correct address value. This is extracted using Address.fromString from the formatted_address property in the response.

    returns

    an sequence of Result objects containing location and geometry data

  16. def lookup(address: String): Seq[Result]

    Lookups a latitude/longitude values for a given address.

    Lookups a latitude/longitude values for a given address.

    A request to the Google Maps API is made to obtain the correct latitude/longitude values.

    address

    a formatted string containing the address, city, and state

    returns

    an sequence of Result objects containing location and geometry data

  17. def lookupPlace(placeId: String): Seq[Result]

    Query the Geocoder API using a Place ID

    Query the Geocoder API using a Place ID

    See also

    lookup(address, parameters)

  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  21. def sendRequest(searchParam: String, searchValue: String): Seq[Result]
    Attributes
    protected
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped