net.aksingh.java.api.owm

Class DailyForecastData

java.lang.Object

net.aksingh.java.api.owm.DailyForecastData

public class DailyForecastData
extends java.lang.Object

Parses daily forecast data (from the JSON data) and provides methods to get/access the information about daily forecasted weather. This class provides has and get methods to access the information.

has methods can be used to check if the data exists, i.e., if the data was available (successfully downloaded) and was parsed correctly.

get methods can be used to access the data, if the data exists, otherwise get methods will give value as per following basis:
Boolean: false
Integral: Minimum value (MIN_VALUE)
Floating point: Not a number (NaN)
Objects: Data initialized with default/non-parameterized constructor
Others: null

Since:

2.5.0.1

Version:

2013/08/07

Author:

Ashutosh Kumar Singh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DailyForecastData.City Parses data about city (from the JSON data) and provides methods to get/access the information.
static class	DailyForecastData.Forecast Parses data about forecasts (from the JSON data) and provides methods to get/access the information.

Field Summary

Fields

Modifier and Type	Field and Description
private DailyForecastData.City	city
private java.util.List<DailyForecastData.Forecast>	forecastList List of forecast information
private int	forecastListCount Count (number) of elements in list of forecast information
private java.lang.String	JSON_CITY Key for JSON object - City
private java.lang.String	JSON_FORECAST_LIST Key for JSON object - List of forecasts
private java.lang.String	JSON_RESPONSE_CODE Key for JSON variable Response code
private java.lang.String	JSON_RESPONSE_FORECAST_COUNT Key for JSON variable Forecast count
private java.lang.String	JSON_RESPONSE_TIME Key for JSON variable Response time
private java.lang.String	responseCode Response code
private int	responseForecastCount Forecast count
private float	responseTime Response time

Constructor Summary

Constructors

Constructor and Description
DailyForecastData(org.json.JSONObject jsonObj) Parameterized constructor Initializes variables from values from the given JSON object.

Method Summary

Methods

Modifier and Type	Method and Description
DailyForecastData.City	getCity_Object()
int	getForecast_List_Count()
java.util.List<DailyForecastData.Forecast>	getForecast_List()
java.lang.String	getResponseCode()
int	getResponseForecastCount()
float	getResponseTime()
boolean	hasForecast_List()
boolean	hasResponseCode()
boolean	hasResponseForecastCount()
boolean	hasResponseTime()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_CITY

private final java.lang.String JSON_CITY

Key for JSON object - City

See Also:

Constant Field Values

JSON_FORECAST_LIST

private final java.lang.String JSON_FORECAST_LIST

Key for JSON object - List of forecasts

See Also:

Constant Field Values

JSON_RESPONSE_CODE

private final java.lang.String JSON_RESPONSE_CODE

Key for JSON variable Response code

See Also:

Constant Field Values

JSON_RESPONSE_TIME

private final java.lang.String JSON_RESPONSE_TIME

Key for JSON variable Response time

See Also:

Constant Field Values

JSON_RESPONSE_FORECAST_COUNT

private final java.lang.String JSON_RESPONSE_FORECAST_COUNT

Key for JSON variable Forecast count

See Also:

Constant Field Values

responseCode

private final java.lang.String responseCode

Response code

responseTime

private final float responseTime

Response time

responseForecastCount

private final int responseForecastCount

Forecast count

city

private final DailyForecastData.City city

forecastList

private final java.util.List<DailyForecastData.Forecast> forecastList

List of forecast information

forecastListCount

private final int forecastListCount

Count (number) of elements in list of forecast information

Constructor Detail

DailyForecastData

public DailyForecastData(org.json.JSONObject jsonObj)

Parameterized constructor Initializes variables from values from the given JSON object.

Parameters:

jsonObj - JSON object containing data about daily forecasts

Method Detail

hasResponseCode

public boolean hasResponseCode()

hasResponseTime

public boolean hasResponseTime()

hasResponseForecastCount

public boolean hasResponseForecastCount()

getResponseCode

public java.lang.String getResponseCode()

getResponseTime

public float getResponseTime()

getResponseForecastCount

public int getResponseForecastCount()

getCity_Object

public DailyForecastData.City getCity_Object()

hasForecast_List

public boolean hasForecast_List()

getForecast_List_Count

public int getForecast_List_Count()

getForecast_List

public java.util.List<DailyForecastData.Forecast> getForecast_List()