com.survivingwithandroid.weather.lib

Class WeatherClient

java.lang.Object

com.survivingwithandroid.weather.lib.WeatherClient

Direct Known Subclasses:

StandardHttpClient, WeatherClientDefault, WeatherDefaultClient

public abstract class WeatherClient
extends java.lang.Object

This class represents the entry point to get the Weather information. This class uses a IWeatherProvider to parse the response. Internally this class is based on Android Volley lib so that you don't have to worry about Thread hanlding because the class makes the remote HTTP request on a separate thread.

Usually you need only one instance of this class in your app so that the class implements the Singleton pattern To get the reference to this class you have to use getInstance method:

WeatherClient client = WeatherClient.getInstance();

soon after you the the reference and before you make any requests you have to pass the Context to this class.

Author:

Francesco Azzola

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WeatherClient.CityEventListener This interface must be implemented by the client that wants to get informed when the city list is ready.
static class	WeatherClient.ClientBuilder This class must be used to obtain a valid instance of WeatherClient.
static interface	WeatherClient.ForecastWeatherEventListener This interface must be implemented by the client that wants to get informed when the forecast weather data is ready.
static interface	WeatherClient.GenericRequestWeatherEventListener<T> This interface must be implemented by the client that wants to get informed when the generic request is available
static interface	WeatherClient.HistoricalWeatherEventListener This interface must be implemented by the client that wants to get informed when the historical weather data is ready.
static interface	WeatherClient.HourForecastWeatherEventListener This interface must be implemented by the client that wants to get informed when the hour forecast weather data is ready.
static interface	WeatherClient.WeatherClientListener This is the base interface.
static interface	WeatherClient.WeatherEventListener This interface must be implemented by the client that wants to get informed when the weather data is ready.
static interface	WeatherClient.WeatherImageListener This interface must be implemented by the client that wants to get informed when the forecast weather image is ready.

Field Summary

Fields

Modifier and Type	Field and Description
protected WeatherClient.CityEventListener	cityListener
protected Context	ctx
static int	LOCATION_TIMEOUT
protected LocationListener	locListener
protected IWeatherProvider	provider

Constructor Summary

Constructors

Constructor and Description
WeatherClient()

Method Summary

Methods

Modifier and Type	Method and Description
static Criteria	createDefaultCriteria()
void	createProvider(IProviderType providerType, WeatherConfig config) Deprecated. Version 1.4 use instead WeatherClient.ClientBuilder
abstract void	getCurrentCondition(java.lang.String location, WeatherClient.WeatherEventListener listener) Deprecated. 1.5.0 Use instead getCurrentCondition(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.WeatherEventListener)
abstract void	getCurrentCondition(WeatherRequest request, WeatherClient.WeatherEventListener listener) Get the current weather condition.
abstract void	getDefaultProviderImage(java.lang.String icon, WeatherClient.WeatherImageListener listener) This is the default image Provider that can be used to get the image provided by the Weather provider
abstract void	getForecastWeather(java.lang.String location, WeatherClient.ForecastWeatherEventListener listener) Deprecated. 1.5.0 Use instead getForecastWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.ForecastWeatherEventListener)
abstract void	getForecastWeather(WeatherRequest request, WeatherClient.ForecastWeatherEventListener listener) Get the forecast weather condition.
abstract void	getHistoricalWeather(java.lang.String location, java.util.Date d1, java.util.Date d2, WeatherClient.HistoricalWeatherEventListener listener) Deprecated. 1.5.0 getHistoricalWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, java.util.Date, java.util.Date, com.survivingwithandroid.weather.lib.WeatherClient.HistoricalWeatherEventListener)
abstract void	getHistoricalWeather(WeatherRequest request, java.util.Date d1, java.util.Date d2, WeatherClient.HistoricalWeatherEventListener listener) Get the historical weather condition.
abstract void	getHourForecastWeather(java.lang.String location, WeatherClient.HourForecastWeatherEventListener listener) Deprecated. 1.5.0 use instead getHourForecastWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.HourForecastWeatherEventListener)
abstract void	getHourForecastWeather(WeatherRequest request, WeatherClient.HourForecastWeatherEventListener listener) Get the forecast weather condition.
abstract void	getImage(java.lang.String url, WeatherClient.WeatherImageListener listener) Get an image at the specified URL and inform the listener when the image is ready
abstract <T extends WeatherProviderFeature,S> void	getProviderWeatherFeature(WeatherRequest request, T extRequest, GenericResponseParser<S> parser, WeatherClient.GenericRequestWeatherEventListener<S> listener) Get a specific weather provider feature not implemented in all weather provider When the data is ready this method calls the onWeatherRetrieved passing the HistoricalWeather weather information.
abstract void	getWeatherImage(java.lang.String cityId, Params params, WeatherClient.WeatherImageListener listener) This method retrieves the image using the url generated by the weahter provider IWeatherProvider
protected void	handleLocation(Criteria criteria, WeatherClient.CityEventListener listener)
void	init(Context ctx) This method has to be called before any HTTP request
abstract void	searchCity(double lat, double lon, WeatherClient.CityEventListener listener) Search the city using latitude and longitude.
abstract void	searchCity(java.lang.String pattern, WeatherClient.CityEventListener listener) Search the city using a name pattern.
abstract void	searchCityByLocation(Criteria criteria, WeatherClient.CityEventListener listener) Search the city using geographic coordinates.
protected abstract void	searchCityByLocation(Location location, WeatherClient.CityEventListener listener)
void	setProvider(IWeatherProvider provider) This method is used to set the Weather provider.
void	updateWeatherConfig(WeatherConfig config) This method update the current provider configuration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

provider

protected IWeatherProvider provider

ctx

protected Context ctx

cityListener

protected WeatherClient.CityEventListener cityListener

LOCATION_TIMEOUT

public static int LOCATION_TIMEOUT

locListener

protected LocationListener locListener

Constructor Detail

WeatherClient

public WeatherClient()

Method Detail

init

public void init(Context ctx)

This method has to be called before any HTTP request

Parameters:

ctx - Reference to the Context

updateWeatherConfig

public void updateWeatherConfig(WeatherConfig config)

This method update the current provider configuration

Parameters:

config - WeatherConfig info

See Also:

WeatherConfig

getCurrentCondition

public abstract void getCurrentCondition(java.lang.String location,
                       WeatherClient.WeatherEventListener listener)
                                  throws ApiKeyRequiredException

Deprecated. 1.5.0 Use instead getCurrentCondition(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.WeatherEventListener)

Get the current weather condition. It returns a class structure that is indipendent from the provider used to ge the weather data. This method is an async method, in other word you have to implement your listener WeatherClient.WeatherEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onWeatherRetrieved passing the current weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

location - a String representing the location id

listener - WeatherClient.WeatherEventListener

Throws:

ApiKeyRequiredException

searchCity

public abstract void searchCity(java.lang.String pattern,
              WeatherClient.CityEventListener listener)
                         throws ApiKeyRequiredException

Search the city using a name pattern. It returns a class structure that is indipendent from the provider used that holds the city list matching the pattern. This method is an async method, in other word you have to implement your listener WeatherClient.CityEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onCityListRetrieved passing a List of cities. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

pattern - a String representing the pattern

listener - WeatherClient.CityEventListener

Throws:

ApiKeyRequiredException

searchCity

public abstract void searchCity(double lat,
              double lon,
              WeatherClient.CityEventListener listener)
                         throws ApiKeyRequiredException

Search the city using latitude and longitude. It returns a class structure that is indipendent from the provider used that holds the city list matching the pattern. This method is an async method, in other word you have to implement your listener WeatherClient.CityEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onCityListRetrieved passing a List of cities. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

lat - a double representing the latitude

lon - a double representing the longitude

listener - WeatherClient.CityEventListener

Throws:

ApiKeyRequiredException

Since:

1.5.3

getForecastWeather

public abstract void getForecastWeather(java.lang.String location,
                      WeatherClient.ForecastWeatherEventListener listener)
                                 throws ApiKeyRequiredException

Deprecated. 1.5.0 Use instead getForecastWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.ForecastWeatherEventListener)

Get the forecast weather condition. It returns a class structure that is independent from the provider used to ge the weather data. This method is an async method, in other word you have to implement your listener WeatherClient.ForecastWeatherEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onWeatherRetrieved passing the WeatherForecast weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

location - a String representing the location id

listener - WeatherClient.ForecastWeatherEventListener

Throws:

ApiKeyRequiredException

getHourForecastWeather

public abstract void getHourForecastWeather(java.lang.String location,
                          WeatherClient.HourForecastWeatherEventListener listener)
                                     throws ApiKeyRequiredException

Deprecated. 1.5.0 use instead getHourForecastWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.HourForecastWeatherEventListener)

Get the forecast weather condition. It returns a class structure that is independent from the provider used to ge the weather data. This method is an async method, in other word you have to implement your listener WeatherClient.HourForecastWeatherEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onWeatherRetrieved passing the WeatherHourForecast weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

location - a String representing the location id

listener - WeatherClient.HourForecastWeatherEventListener

Throws:

ApiKeyRequiredException

getHistoricalWeather

public abstract void getHistoricalWeather(java.lang.String location,
                        java.util.Date d1,
                        java.util.Date d2,
                        WeatherClient.HistoricalWeatherEventListener listener)

Deprecated. 1.5.0 getHistoricalWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, java.util.Date, java.util.Date, com.survivingwithandroid.weather.lib.WeatherClient.HistoricalWeatherEventListener)

Get the historical weather condition. It returns a class structure that is independent from the provider used to ge the weather data. This method is an async method, in other word you have to implement your listener WeatherClient.HistoricalWeatherEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onWeatherRetrieved passing the HistoricalWeather weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

location - a String representing the location id

d1 - is the starting date

d2 - is the end date

listener - WeatherClient.HistoricalWeatherEventListener

Throws:

ApiKeyRequiredException

getDefaultProviderImage

public abstract void getDefaultProviderImage(java.lang.String icon,
                           WeatherClient.WeatherImageListener listener)

This is the default image Provider that can be used to get the image provided by the Weather provider

Parameters:

icon - String The icon containing the weather code to retrieve the image

listener - WeatherClient.WeatherImageListener

searchCityByLocation

public abstract void searchCityByLocation(Criteria criteria,
                        WeatherClient.CityEventListener listener)
                                   throws LocationProviderNotFoundException

Search the city using geographic coordinates. It returns a class structure that is independent from the provider used that holds the city list matching the pattern. This method is an async method, in other word you have to implement your listener WeatherClient.CityEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onCityListRetrieved passing a List of cities. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

criteria - android.location.Criteria

listener - WeatherClient.CityEventListener

Throws:

ApiKeyRequiredException

LocationProviderNotFoundException

getWeatherImage

public abstract void getWeatherImage(java.lang.String cityId,
                   Params params,
                   WeatherClient.WeatherImageListener listener)

This method retrieves the image using the url generated by the weahter provider IWeatherProvider

Parameters:

cityId - String representing the city id

params - Params: list of parameters used to create the image

listener - WeatherClient.WeatherImageListener listener that gets notified when the image is ready to use

setProvider

public void setProvider(IWeatherProvider provider)

This method is used to set the Weather provider. The Weather provider must implement (IWeatherProvider interface. This method has to be called before making any HTTP request otherwise the client doesn't know how to parse the request

Parameters:

provider - IWeatherProvider

See Also:

com.survivingwithandroid.weather.lib.provider.openweathermap.OpenweathermapProvider}, com.survivingwithandroid.weather.lib.provider.yahooweather.YahooWeatherProvider}

createDefaultCriteria

public static Criteria createDefaultCriteria()

createProvider

public void createProvider(IProviderType providerType,
                  WeatherConfig config)
                    throws WeatherProviderInstantiationException

Deprecated. Version 1.4 use instead WeatherClient.ClientBuilder

This method creates the Weather provider. It is the same: IWeatherProvider provider = null; try { provider = WeatherProviderFactory.createProvider(new OpenweathermapProviderType(), config); client.setProvider(provider); } catch (Throwable t) { t.printStackTrace(); // There's a problem }

Throws:

WeatherProviderInstantiationException

handleLocation

protected void handleLocation(Criteria criteria,
                  WeatherClient.CityEventListener listener)
                       throws LocationProviderNotFoundException

Throws:

LocationProviderNotFoundException

searchCityByLocation

protected abstract void searchCityByLocation(Location location,
                        WeatherClient.CityEventListener listener)
                                      throws ApiKeyRequiredException

Throws:

ApiKeyRequiredException

getCurrentCondition

public abstract void getCurrentCondition(WeatherRequest request,
                       WeatherClient.WeatherEventListener listener)
                                  throws ApiKeyRequiredException

Get the current weather condition. It returns a class structure that is indipendent from the provider used to ge the weather data. This method is an async method, in other word you have to implement your listener WeatherClient.WeatherEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onWeatherRetrieved passing the current weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

request - WeatherRequest

listener - WeatherClient.WeatherEventListener

Throws:

ApiKeyRequiredException

getForecastWeather

public abstract void getForecastWeather(WeatherRequest request,
                      WeatherClient.ForecastWeatherEventListener listener)
                                 throws ApiKeyRequiredException

Get the forecast weather condition. It returns a class structure that is independent from the provider used to ge the weather data. This method is an async method, in other word you have to implement your listener WeatherClient.ForecastWeatherEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onWeatherRetrieved passing the WeatherForecast weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

request - WeatherRequest

listener - WeatherClient.ForecastWeatherEventListener

Throws:

ApiKeyRequiredException

getHourForecastWeather

public abstract void getHourForecastWeather(WeatherRequest request,
                          WeatherClient.HourForecastWeatherEventListener listener)
                                     throws ApiKeyRequiredException

Get the forecast weather condition. It returns a class structure that is independent from the provider used to ge the weather data. This method is an async method, in other word you have to implement your listener WeatherClient.HourForecastWeatherEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onWeatherRetrieved passing the WeatherHourForecast weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

request - WeatherRequest

listener - WeatherClient.HourForecastWeatherEventListener

Throws:

ApiKeyRequiredException

getHistoricalWeather

public abstract void getHistoricalWeather(WeatherRequest request,
                        java.util.Date d1,
                        java.util.Date d2,
                        WeatherClient.HistoricalWeatherEventListener listener)

Get the historical weather condition. It returns a class structure that is independent from the provider used to ge the weather data. This method is an async method, in other word you have to implement your listener WeatherClient.HistoricalWeatherEventListener to get notified when the weather data is ready.

When the data is ready this method calls the onWeatherRetrieved passing the HistoricalWeather weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

request - WeatherRequest

d1 - is the starting date

d2 - is the end date

listener - WeatherClient.HistoricalWeatherEventListener

Throws:

ApiKeyRequiredException

getProviderWeatherFeature

public abstract <T extends WeatherProviderFeature,S> void getProviderWeatherFeature(WeatherRequest request,
                                                                  T extRequest,
                                                                  GenericResponseParser<S> parser,
                                                                  WeatherClient.GenericRequestWeatherEventListener<S> listener)

Get a specific weather provider feature not implemented in all weather provider

When the data is ready this method calls the onWeatherRetrieved passing the HistoricalWeather weather information. If there are some errors during the request parsing, it calls onWeatherError passing the exception or onConnectionError if the errors happened during the HTTP connection

Parameters:

request - WeatherRequest

extRequest - is the extended request as required by the weather provider

parser - is the parser used to parsed the response GenericResponseParser

listener - WeatherClient.GenericRequestWeatherEventListener

Throws:

ApiKeyRequiredException

getImage

public abstract void getImage(java.lang.String url,
            WeatherClient.WeatherImageListener listener)

Get an image at the specified URL and inform the listener when the image is ready

Parameters:

url - String representing the url

listener - WeatherClient.WeatherImageListener

Since:

1.5.3