package geocoder
- Alphabetic
- Public
- All
Type Members
- sealed abstract class AbstractComponent extends AnyRef
-
case class
AddressComponent
(longName: String, shortName: String, types: Seq[String]) extends Product with Serializable
Contains meta data about the address.
Contains meta data about the address.
AddressComponents can contain any part of the address field. This includes street, city, state, etc.. the field type can be determined by the
types
Seq. -
case class
AdministrativeAreaComponent
(value: String) extends AbstractComponent with Product with Serializable
Serializes to "administrative_area=value"
-
class
AsyncGeocoder
extends AnyRef
Use the geocoding API with asynchonous requests
Use the geocoding API with asynchonous requests
Simple composition class that executes the Geocoder methods within and implicit
scala.concurrent.ExecutionContext
. Exceptions are automatically bubbled up to theonFailure
events. Allscala.concurrent.Future[Result]
contain the return values from the wrapper com.koddi.geocoder.Geocoder. - case class Component (key: String, value: String) extends AbstractComponent with Product with Serializable
-
case class
CountryComponent
(value: String) extends AbstractComponent with Product with Serializable
Serializes to "country=value"
-
case class
FailedResponseException
(status: String, message: String) extends Exception with Product with Serializable
Thrown when the API returns a generic error
-
class
Geocoder
extends AnyRef
Converts strings and addresses to latitude/longitude values.
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.
-
case class
Geometry
(location: Location, locationType: String, viewport: GeometryBounds, bounds: Option[GeometryBounds]) extends Product with Serializable
High level geometry data related to the queried location.
-
case class
GeometryBounds
(northeast: Location, southwest: Location) extends Product with Serializable
Bounding points the represent opposite edges of a square.
Bounding points the represent opposite edges of a square.
- northeast
the upper right coordinate of the square
- southwest
the lower left coordinate of the square
-
case class
InvalidRequestException
(message: String) extends Exception with Product with Serializable
Thrown when the API returns INVALID_REQUEST status.
Thrown when the API returns INVALID_REQUEST status. Will contain the applicable error message.
- class InvalidResponseException extends Exception
-
case class
LocalityComponent
(value: String) extends AbstractComponent with Product with Serializable
Serializes to "locality=value"
-
case class
Location
(latitude: Double, longitude: Double) extends Product with Serializable
Simple wrapper for storing latitude and longitude values
Simple wrapper for storing latitude and longitude values
Internally the
toString()
method is overriden so it can write the latitude/longitude values as a coordinate string. -
case class
OverQueryLimitException
(message: String) extends Exception with Product with Serializable
Thrown when the API returns OVER_QUERY_LIMIT status.
Thrown when the API returns OVER_QUERY_LIMIT status. Will contain the applicable error message.
- case class Parameters (language: Option[String] = None, region: Option[String] = None, bounds: Option[GeometryBounds] = None, resultType: Option[Seq[String]] = None, locationType: Option[Seq[String]] = None) extends Product with Serializable
-
case class
PostalCodeComponent
(value: String) extends AbstractComponent with Product with Serializable
Serializes to "postal_code=value"
-
case class
Response
(status: String, results: Seq[Result], errorMessage: Option[String]) extends Product with Serializable
The Google Maps response wrapper
The Google Maps response wrapper
This entity represents the JSON response returned from the Google Maps API.
-
class
ResponseParser
extends AnyRef
Parses Google Maps XML responses and converts them into com.koddi.geocoder.Response.
Parses Google Maps XML responses and converts them into com.koddi.geocoder.Response.
- See also
https://developers.google.com/maps/documentation/geocoding/intro#Results
-
case class
ResponseParsingException
(e: Exception) extends Exception with Product with Serializable
Thrown when the response contains an invalid payload that cannot be parsed by the XML reader
-
case class
Result
(placeId: String, formattedAddress: String, geometry: Geometry, addressComponents: Seq[AddressComponent], postcodeLocalities: Option[Seq[String]], partialMatch: Boolean, types: Seq[String]) extends Product with Serializable
A collection of location and geometry data.
-
case class
RouteComponent
(value: String) extends AbstractComponent with Product with Serializable
Serializes to "route=value"
Value Members
-
object
AddressComponent
extends Serializable
Provides constants for com.koddi.geocoder.AddressComponent
- object Component extends Serializable
-
object
Geocoder
Factory for com.koddi.geocoder.Geocoder instances.
-
object
Location
extends Serializable
Provides constants related to com.koddi.geocoder.Location
- object Response extends Serializable