net.aksingh.java.api.owm

Class ForecastWeatherData.Forecast

java.lang.Object

net.aksingh.java.api.owm.AbstractWeatherData

net.aksingh.java.api.owm.ForecastWeatherData.Forecast

Enclosing class:

ForecastWeatherData

public static class ForecastWeatherData.Forecast
extends AbstractWeatherData

Parses data about forecasts (from the JSON data) and provides methods to get/access the information. 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)
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	ForecastWeatherData.Forecast.Clouds Parses data about clouds (from the JSON data) and provides methods to get/access the information.
static class	ForecastWeatherData.Forecast.Main Parses data about main weather elements (from the JSON data) and provides methods to get/access the information.
static class	ForecastWeatherData.Forecast.Sys Parses data about main weather elements (from the JSON data) and provides methods to get/access the information.
static class	ForecastWeatherData.Forecast.Weather Parses data about weather (from the JSON data) and provides methods to get/access the information.
static class	ForecastWeatherData.Forecast.Wind Parses data about wind (from the JSON data) and provides methods to get/access the information.

Nested classes/interfaces inherited from class net.aksingh.java.api.owm.AbstractWeatherData

AbstractWeatherData.Coord

Field Summary

Fields

Modifier and Type	Field and Description
private ForecastWeatherData.Forecast.Clouds	clouds
private java.lang.String	dateTimeText Date time text
private java.lang.String	JSON_DATE_TIME_TEXT Key for JSON variable Date time text
private java.lang.String	JSON_SYS Key for JSON object - Sys (pod, etc.)
private ForecastWeatherData.Forecast.Main	main
private ForecastWeatherData.Forecast.Sys	sys
private java.util.List<ForecastWeatherData.Forecast.Weather>	weatherList List of weather information (code, name, etc.)
private int	weatherListCount Count (number) of elements in list of weather information
private ForecastWeatherData.Forecast.Wind	wind

Fields inherited from class net.aksingh.java.api.owm.AbstractWeatherData

JSON_CLOUDS, JSON_COORD, JSON_MAIN, JSON_WEATHER, JSON_WIND

Constructor Summary

Constructors

Constructor and Description
ForecastWeatherData.Forecast() Non-parameterized constructor
ForecastWeatherData.Forecast(org.json.JSONObject jsonObj) Parameterized constructor Initializes variables from values from the given JSON object.

Method Summary

Methods

Modifier and Type	Method and Description
ForecastWeatherData.Forecast.Clouds	getClouds_Object()
java.lang.String	getDateTimeText()
ForecastWeatherData.Forecast.Main	getMainData_Object()
ForecastWeatherData.Forecast.Sys	getSysData_Object()
int	getWeather_List_Count()
java.util.List<ForecastWeatherData.Forecast.Weather>	getWeather_List()
ForecastWeatherData.Forecast.Wind	getWind_Object()
boolean	hasDateTimeText()
boolean	hasWeather_List()

Methods inherited from class net.aksingh.java.api.owm.AbstractWeatherData

getDateTime, hasDateTime

Methods inherited from class java.lang.Object

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

Field Detail

JSON_SYS

private final java.lang.String JSON_SYS

Key for JSON object - Sys (pod, etc.)

See Also:

Constant Field Values

JSON_DATE_TIME_TEXT

private final java.lang.String JSON_DATE_TIME_TEXT

Key for JSON variable Date time text

See Also:

Constant Field Values

dateTimeText

private final java.lang.String dateTimeText

Date time text

clouds

private final ForecastWeatherData.Forecast.Clouds clouds

main

private final ForecastWeatherData.Forecast.Main main

sys

private final ForecastWeatherData.Forecast.Sys sys

wind

private final ForecastWeatherData.Forecast.Wind wind

weatherList

private final java.util.List<ForecastWeatherData.Forecast.Weather> weatherList

List of weather information (code, name, etc.)

weatherListCount

private final int weatherListCount

Count (number) of elements in list of weather information

Constructor Detail

ForecastWeatherData.Forecast

public ForecastWeatherData.Forecast()

Non-parameterized constructor

Initializes variables as per following basis:
Boolean: false
Integral: Minimum value (MIN_VALUE)
Floating point: Not a number (NaN)
Others: null

ForecastWeatherData.Forecast

public ForecastWeatherData.Forecast(org.json.JSONObject jsonObj)

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

Parameters:

jsonObj - JSON object containing data about forecasts

Method Detail

hasDateTimeText

public boolean hasDateTimeText()

getDateTimeText

public java.lang.String getDateTimeText()

getClouds_Object

public ForecastWeatherData.Forecast.Clouds getClouds_Object()

getMainData_Object

public ForecastWeatherData.Forecast.Main getMainData_Object()

getSysData_Object

public ForecastWeatherData.Forecast.Sys getSysData_Object()

getWind_Object

public ForecastWeatherData.Forecast.Wind getWind_Object()

hasWeather_List

public boolean hasWeather_List()

getWeather_List_Count

public int getWeather_List_Count()

getWeather_List

public java.util.List<ForecastWeatherData.Forecast.Weather> getWeather_List()