OwmCacheClient

Instance Constructors

new OwmCacheClient(cacheSize: Int, geoPrecision: Int, asyncClient: OwmAsyncClient, timeout: Int)

cacheSize
amount of history requests storing in cache it's better to store whole OWM packet (5000/50000/150000) plus some space for errors (~1%)
geoPrecision
nth part of 1 to which latitude and longitude will be rounded stored in cache. For eg. coordinate 45.678 will be rounded to values 46.0, 45.5, 45.7, 45.78 by geoPrecision 1,2,10,100 respectively geoPrecision 1 will give ~60km infelicity if worst case; 2 ~30km etc
asyncClient
instance of OwmAsyncClient which will do all underlying work
timeout
timeout in seconds after which active request will be considered failed

Type Members

type Cache = SynchronizedLruMap[CacheKey, Either[WeatherError, History]]

Definition Classes
WeatherCache

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val cache: Cache

Attributes
protected
Definition Classes
WeatherCache
val cacheSize: Int

amount of history requests storing in cache it's better to store whole OWM packet (5000/50000/150000) plus some space for errors (~1%)
amount of history requests storing in cache it's better to store whole OWM packet (5000/50000/150000) plus some space for errors (~1%)

Definition Classes
OwmCacheClient → WeatherCache
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def currentByCoords(lat: Float, lon: Float): ValidatedWeather[Current]

Get current weather data by city coordinates Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_weather#2-By-geographic-coordinate
Get current weather data by city coordinates Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_weather#2-By-geographic-coordinate
lat
latitude
lon
longitude
returns
either error or current weather wrapped in Response

Definition Classes
Client
def currentById(id: Int): ValidatedWeather[Current]

Get current weather data by city id Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_weather#3-By-city-ID
Get current weather data by city id Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_weather#3-By-city-ID
id
id of the city
returns
either error or current weather wrapped in Response

Definition Classes
Client
def currentByName(name: String, country: OptArg[String], cnt: OptArg[Int] = None): ValidatedWeather[Current]

Get 5 day/3 hour forecast data by city name Docs: http://openweathermap.org/forecast#5days
Get 5 day/3 hour forecast data by city name Docs: http://openweathermap.org/forecast#5days
name
name of the city
country
optional two-letter code
cnt
count of returned data
returns
either error or forecast wrapped in Response

Definition Classes
Client
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def eventToCacheKey(timestamp: Timestamp, position: Position): CacheKey

Round position and timestamp (event) to produce cache key
Round position and timestamp (event) to produce cache key
timestamp
timestamp in seconds
position
latitude & longitude
returns
cache key

Definition Classes
WeatherCache
def extractWeather[W](response: JValue)(implicit arg0: Manifest[W]): Either[WeatherError, W]

Transform JSON into parseable format and try to extract specified response
Transform JSON into parseable format and try to extract specified response
W
specific response case class from com.snowplowanalytics.weather.providers.openweather.Responses
response
either of previous or JSON
returns
either error string or response case class

Attributes
protected[com.snowplowanalytics.weather.providers.openweather]
Definition Classes
Client
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def forecastByCoords(lat: Float, lon: Float, cnt: OptArg[Int] = None): ValidatedWeather[Weather]

Get forecast data for coordinates
Get forecast data for coordinates
lat
latitude
lon
longitude
returns
either error or forecast wrapped in Response

Definition Classes
Client
def forecastById(id: Int, cnt: OptArg[Int] = None): ValidatedWeather[Forecast]

Get forecast data by city id Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_forecast#Get-forecast-by-city-id
Get forecast data by city id Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_forecast#Get-forecast-by-city-id
id
id of the city
returns
either error or forecast wrapped in Response

Definition Classes
Client
def forecastByName(name: String, country: OptArg[String], cnt: OptArg[Int] = None): ValidatedWeather[Forecast]

Get 5 day/3 hour forecast data by city name Docs: http://openweathermap.org/forecast#5days
Get 5 day/3 hour forecast data by city name Docs: http://openweathermap.org/forecast#5days
name
name of the city
country
optional two-letter code
cnt
count of returned data
returns
either error or forecast wrapped in Response

Definition Classes
Client
val geoPrecision: Int

nth part of 1 to which latitude and longitude will be rounded stored in cache.
nth part of 1 to which latitude and longitude will be rounded stored in cache. For eg. coordinate 45.678 will be rounded to values 46.0, 45.5, 45.7, 45.78 by geoPrecision 1,2,10,100 respectively geoPrecision 1 will give ~60km infelicity if worst case; 2 ~30km etc

Definition Classes
OwmCacheClient → WeatherCache
def getCachedOrRequest(latitude: Float, longitude: Float, timestamp: DateTime): Either[WeatherError, Weather]

Overloaded getCachedOrRequest method with Joda DateTime instead of Unix epoch timestamp
def getCachedOrRequest(latitude: Float, longitude: Float, timestamp: Int): Either[WeatherError, Weather]

Search history in cache and if not found request and await it from server and put to the cache.
Search history in cache and if not found request and await it from server and put to the cache. If timeout error was taken from cache, do request again
latitude
event's latitude
longitude
event's longitude
timestamp
event's timestamp
returns
weather stamp immediately taken from cache or requested from server
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getStartOfDay(timestamp: Timestamp): Day

Get timestamp for beginning of the day
Get timestamp for beginning of the day
timestamp
event's timestamp
returns
timestamp for beginning of day of this event

Definition Classes
WeatherCache
def hashCode(): Int

Definition Classes
AnyRef → Any
def historyByCoords(lat: Float, lon: Float, start: OptArg[Int] = None, end: OptArg[Int] = None, cnt: OptArg[Int] = None, measure: OptArg[Api.Measures.Value] = None): ValidatedWeather[History]

Get historical data by city name Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_history#By-city-name
Get historical data by city name Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_history#By-city-name
lat
lattitude
lon
longitude
start
start (unix time, UTC)
end
end (unix time, UTC)
cnt
count of returned data
measure
one of predefined Api.Measures to constrain accuracy
returns
either error or history wrapped in Response

Definition Classes
Client
def historyById(id: Int, start: OptArg[Int] = None, end: OptArg[Int] = None, cnt: OptArg[Int] = None, measure: OptArg[Api.Measures.Value] = None): ValidatedWeather[History]

Get historical data by city id Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_history#By-city-id
Get historical data by city id Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_history#By-city-id
id
id of the city
start
start (unix time, UTC)
end
end (unix time, UTC)
cnt
count of returned data
measure
one of predefined Api.Measures to constrain accuracy
returns
either error or history wrapped in Response

Definition Classes
Client
def historyByName(name: String, country: OptArg[String] = None, start: OptArg[Int] = None, end: OptArg[Int] = None, cnt: OptArg[Int] = None, measure: OptArg[Api.Measures.Value] = None): ValidatedWeather[History]

Get historical data by city name Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_history#By-city-name
Get historical data by city name Docs: http://bugs.openweathermap.org/projects/api/wiki/Api_2_5_history#By-city-name
name
name of the city
country
optional two-letter code
start
start (unix time, UTC)
end
end (unix time, UTC)
cnt
count of returned data
measure
one of predefined Api.Measures to constrain accuracy
returns
either error or history wrapped in Response

Definition Classes
Client
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def receive[W <: OwmResponse](request: OwmRequest)(implicit arg0: Manifest[W]): Either[WeatherError, W]

Main client logic for Request => Response function, where Response is wrappeed in tparam Response
Main client logic for Request => Response function, where Response is wrappeed in tparam Response
W
type of weather response to extract
returns
extracted either error or weather

Definition Classes
OwmCacheClient → Client
def roundCoordinate(coordinate: Float): Float

Round coordinate by geoPrecision Scale value to tenths to prevent values to be long like 1.333334
Round coordinate by geoPrecision Scale value to tenths to prevent values to be long like 1.333334
coordinate
latitude or longitude
returns
rounded coordinate

Definition Classes
WeatherCache
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val timeout: Int

timeout in seconds after which active request will be considered failed
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object OwmCacheClient | package openweather

class OwmCacheClient extends Client[ValidatedWeather] with WeatherCache[History]

Instance Constructors

new OwmCacheClient(cacheSize: Int, geoPrecision: Int, asyncClient: OwmAsyncClient, timeout: Int)

Type Members

type Cache = SynchronizedLruMap[CacheKey, Either[WeatherError, History]]

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val cache: Cache

val cacheSize: Int

def clone(): AnyRef

def currentByCoords(lat: Float, lon: Float): ValidatedWeather[Current]

def currentById(id: Int): ValidatedWeather[Current]

def currentByName(name: String, country: OptArg[String], cnt: OptArg[Int] = None): ValidatedWeather[Current]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def eventToCacheKey(timestamp: Timestamp, position: Position): CacheKey

def extractWeather[W](response: JValue)(implicit arg0: Manifest[W]): Either[WeatherError, W]

def finalize(): Unit

def forecastByCoords(lat: Float, lon: Float, cnt: OptArg[Int] = None): ValidatedWeather[Weather]

def forecastById(id: Int, cnt: OptArg[Int] = None): ValidatedWeather[Forecast]

def forecastByName(name: String, country: OptArg[String], cnt: OptArg[Int] = None): ValidatedWeather[Forecast]

val geoPrecision: Int

def getCachedOrRequest(latitude: Float, longitude: Float, timestamp: DateTime): Either[WeatherError, Weather]

def getCachedOrRequest(latitude: Float, longitude: Float, timestamp: Int): Either[WeatherError, Weather]

final def getClass(): Class[_]

def getStartOfDay(timestamp: Timestamp): Day

def hashCode(): Int

def historyByCoords(lat: Float, lon: Float, start: OptArg[Int] = None, end: OptArg[Int] = None, cnt: OptArg[Int] = None, measure: OptArg[Api.Measures.Value] = None): ValidatedWeather[History]

def historyById(id: Int, start: OptArg[Int] = None, end: OptArg[Int] = None, cnt: OptArg[Int] = None, measure: OptArg[Api.Measures.Value] = None): ValidatedWeather[History]

def historyByName(name: String, country: OptArg[String] = None, start: OptArg[Int] = None, end: OptArg[Int] = None, cnt: OptArg[Int] = None, measure: OptArg[Api.Measures.Value] = None): ValidatedWeather[History]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def receive[W <: OwmResponse](request: OwmRequest)(implicit arg0: Manifest[W]): Either[WeatherError, W]

def roundCoordinate(coordinate: Float): Float

final def synchronized[T0](arg0: ⇒ T0): T0

val timeout: Int

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from WeatherCache[History]

Inherited from Client[ValidatedWeather]

Inherited from AnyRef

Inherited from Any

Ungrouped