com.survivingwithandroid.weather.lib.client.volley

Class WeatherClientDefault

java.lang.Object

com.survivingwithandroid.weather.lib.WeatherClient

com.survivingwithandroid.weather.lib.client.volley.WeatherClientDefault

public class WeatherClientDefault
extends WeatherClient

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/interfaces inherited from class com.survivingwithandroid.weather.lib.WeatherClient

WeatherClient.CityEventListener, WeatherClient.ClientBuilder, WeatherClient.ForecastWeatherEventListener, WeatherClient.GenericRequestWeatherEventListener<T>, WeatherClient.HistoricalWeatherEventListener, WeatherClient.HourForecastWeatherEventListener, WeatherClient.WeatherClientListener, WeatherClient.WeatherEventListener, WeatherClient.WeatherImageListener

Field Summary

Fields inherited from class com.survivingwithandroid.weather.lib.WeatherClient

ctx, LOCATION_TIMEOUT, locListener, provider

Constructor Summary

Constructors

Constructor and Description
WeatherClientDefault()

Method Summary

Methods

Modifier and Type	Method and Description
void	getCurrentCondition(java.lang.String location, WeatherClient.WeatherEventListener listener) Deprecated. use instead WeatherClient.getCurrentCondition(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.WeatherEventListener)
void	getCurrentCondition(WeatherRequest wRequest, WeatherClient.WeatherEventListener listener) Get the current weather condition.
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
void	getForecastWeather(java.lang.String location, WeatherClient.ForecastWeatherEventListener listener) Deprecated. use instead WeatherClient.getForecastWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.ForecastWeatherEventListener)
void	getForecastWeather(WeatherRequest wRequest, WeatherClient.ForecastWeatherEventListener listener) Get the forecast weather condition.
void	getHistoricalWeather(java.lang.String location, java.util.Date startDate, java.util.Date endDate, WeatherClient.HistoricalWeatherEventListener listener) Deprecated. use instead WeatherClient.getHistoricalWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, java.util.Date, java.util.Date, com.survivingwithandroid.weather.lib.WeatherClient.HistoricalWeatherEventListener)
void	getHistoricalWeather(WeatherRequest wRequest, java.util.Date d1, java.util.Date d2, WeatherClient.HistoricalWeatherEventListener listener) Get the historical weather condition.
void	getHourForecastWeather(java.lang.String location, WeatherClient.HourForecastWeatherEventListener listener) Deprecated. use instead WeatherClient.getHourForecastWeather(com.survivingwithandroid.weather.lib.request.WeatherRequest, com.survivingwithandroid.weather.lib.WeatherClient.HourForecastWeatherEventListener)
void	getHourForecastWeather(WeatherRequest wRequest, WeatherClient.HourForecastWeatherEventListener listener) Get the forecast weather condition.
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
static WeatherClientDefault	getInstance() Deprecated. Release 1.4 repleaced by WeatherClient.ClientBuilder
<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.
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
void	init(Context ctx) This method has to be called before any HTTP request
void	searchCity(double lat, double lon, WeatherClient.CityEventListener listener) Search the city using latitude and longitude.
void	searchCity(java.lang.String pattern, WeatherClient.CityEventListener listener) Search the city using a name pattern.
void	searchCityByLocation(Criteria criteria, WeatherClient.CityEventListener listener)
protected 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 com.survivingwithandroid.weather.lib.WeatherClient

createDefaultCriteria, createProvider, handleLocation

Methods inherited from class java.lang.Object

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

Constructor Detail

WeatherClientDefault

public WeatherClientDefault()

Method Detail

getInstance

public static WeatherClientDefault getInstance()

Deprecated. Release 1.4 repleaced by WeatherClient.ClientBuilder

init

public void init(Context ctx)

Description copied from class: WeatherClient

This method has to be called before any HTTP request

Overrides:

init in class WeatherClient

Parameters:

ctx - Reference to the Context

updateWeatherConfig

public void updateWeatherConfig(WeatherConfig config)

This method update the current provider configuration

Overrides:

updateWeatherConfig in class WeatherClient

Parameters:

config - WeatherConfig info

See Also:

WeatherConfig

getCurrentCondition

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

Deprecated. use instead WeatherClient.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

Specified by:

getCurrentCondition in class WeatherClient

Parameters:

location - a String representing the location id

listener - WeatherClient.WeatherEventListener

Throws:

ApiKeyRequiredException

searchCity

public 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

Specified by:

searchCity in class WeatherClient

Parameters:

pattern - a String representing the pattern

listener - WeatherClient.CityEventListener

Throws:

ApiKeyRequiredException

searchCity

public 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

Specified by:

searchCity in class WeatherClient

Parameters:

lat - a double representing the latitude

lon - a double representing the longitude

listener - WeatherClient.CityEventListener

Throws:

ApiKeyRequiredException

Since:

1.5.3

getForecastWeather

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

Deprecated. use instead WeatherClient.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 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.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

Specified by:

getForecastWeather in class WeatherClient

Parameters:

location - a String representing the location id

listener - WeatherClient.ForecastWeatherEventListener

Throws:

ApiKeyRequiredException

getHourForecastWeather

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

Deprecated. use instead WeatherClient.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

Specified by:

getHourForecastWeather in class WeatherClient

Parameters:

location - a String representing the location id

listener - WeatherClient.HourForecastWeatherEventListener

Throws:

ApiKeyRequiredException

getHistoricalWeather

public void getHistoricalWeather(java.lang.String location,
                        java.util.Date startDate,
                        java.util.Date endDate,
                        WeatherClient.HistoricalWeatherEventListener listener)
                          throws ApiKeyRequiredException

Deprecated. use instead WeatherClient.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

Specified by:

getHistoricalWeather in class WeatherClient

Parameters:

location - a String representing the location id

listener - WeatherClient.HistoricalWeatherEventListener

startDate - is the starting date

endDate - is the end date

Throws:

ApiKeyRequiredException

getDefaultProviderImage

public 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

Specified by:

getDefaultProviderImage in class WeatherClient

Parameters:

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

listener - WeatherClient.WeatherImageListener

searchCityByLocation

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

Specified by:

searchCityByLocation in class WeatherClient

Throws:

LocationProviderNotFoundException

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

Overrides:

setProvider in class WeatherClient

Parameters:

provider - IWeatherProvider

See Also:

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

getWeatherImage

public 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

Specified by:

getWeatherImage in class WeatherClient

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

searchCityByLocation

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

Specified by:

searchCityByLocation in class WeatherClient

Throws:

ApiKeyRequiredException

getCurrentCondition

public void getCurrentCondition(WeatherRequest wRequest,
                       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

Specified by:

getCurrentCondition in class WeatherClient

Parameters:

wRequest - WeatherRequest

listener - WeatherClient.WeatherEventListener

Throws:

ApiKeyRequiredException

getForecastWeather

public void getForecastWeather(WeatherRequest wRequest,
                      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

Specified by:

getForecastWeather in class WeatherClient

Parameters:

wRequest - WeatherRequest

listener - WeatherClient.ForecastWeatherEventListener

Throws:

ApiKeyRequiredException

getHourForecastWeather

public void getHourForecastWeather(WeatherRequest wRequest,
                          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

Specified by:

getHourForecastWeather in class WeatherClient

Parameters:

wRequest - WeatherRequest

listener - WeatherClient.HourForecastWeatherEventListener

Throws:

ApiKeyRequiredException

getHistoricalWeather

public void getHistoricalWeather(WeatherRequest wRequest,
                        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

Specified by:

getHistoricalWeather in class WeatherClient

Parameters:

wRequest - WeatherRequest

d1 - is the starting date

d2 -

listener - WeatherClient.HistoricalWeatherEventListener @param2 d2 is the end date

Throws:

ApiKeyRequiredException

getProviderWeatherFeature

public <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

Specified by:

getProviderWeatherFeature in class WeatherClient

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 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

Specified by:

getImage in class WeatherClient

Parameters:

url - String representing the url

listener - WeatherClient.WeatherImageListener

Since:

1.5.3