net.aksingh.java.api.owm

Class CurrentWeatherData

java.lang.Object

net.aksingh.java.api.owm.AbstractWeatherData

net.aksingh.java.api.owm.CurrentWeatherData

public class CurrentWeatherData
extends AbstractWeatherData

Parses current weather data (from the JSON data) and provides methods to get/access the information about current 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)
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	CurrentWeatherData.Clouds Parses data about clouds (from the JSON data) and provides methods to get/access the information.
static class	CurrentWeatherData.Coord Parses data about geographic coordinates (from the JSON data) and provides methods to get/access the information.
static class	CurrentWeatherData.Main Parses data about main weather elements (from the JSON data) and provides methods to get/access the information.
static class	CurrentWeatherData.Rain Parses data about rain (from the JSON data) and provides methods to get/access the information.
static class	CurrentWeatherData.Sys Parses data about country, sunrise, and sunset (from the JSON data) and provides methods to get/access the information.
static class	CurrentWeatherData.Weather Parses data about weather code, name, etc.
static class	CurrentWeatherData.Wind Parses data about winds (from the JSON data) and provides methods to get/access the information.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	base Base
private long	cityID City code (ID)
private java.lang.String	cityName City name
private CurrentWeatherData.Clouds	clouds
private CurrentWeatherData.Coord	coord
private java.lang.String	JSON_BASE Key for JSON variable Base
private java.lang.String	JSON_CITY_ID Key for JSON variable City code (ID)
private java.lang.String	JSON_CITY_NAME Key for JSON variable City name
private java.lang.String	JSON_RAIN Key for JSON object - Rain
private java.lang.String	JSON_RESPONSE_CODE Key for JSON variable Response code
private java.lang.String	JSON_SYS Key for JSON object - Sys
private CurrentWeatherData.Main	main
private CurrentWeatherData.Rain	rain
private int	responseCode Response code
private CurrentWeatherData.Sys	sys
private java.util.List<CurrentWeatherData.Weather>	weatherList List of weather information (code, name, etc.)
private int	weatherListCount Count (number) of elements in list of weather information
private CurrentWeatherData.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
CurrentWeatherData(org.json.JSONObject jsonObj) Parameterized constructor Initializes variables from values from the given JSON object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBaseStation()
long	getCityCode()
java.lang.String	getCityName()
CurrentWeatherData.Clouds	getClouds_Object()
CurrentWeatherData.Coord	getCoordinates_Object()
CurrentWeatherData.Main	getMainData_Object()
CurrentWeatherData.Rain	getRain_Object()
int	getResponseCode()
CurrentWeatherData.Sys	getSysData_Object()
int	getWeather_List_Count()
java.util.List<CurrentWeatherData.Weather>	getWeather_List()
CurrentWeatherData.Wind	getWind_Object()
boolean	hasBaseStation()
boolean	hasCityCode()
boolean	hasCityName()
boolean	hasResponseCode()
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_RAIN

private final java.lang.String JSON_RAIN

Key for JSON object - Rain

See Also:

Constant Field Values

JSON_SYS

private final java.lang.String JSON_SYS

Key for JSON object - Sys

See Also:

Constant Field Values

JSON_BASE

private final java.lang.String JSON_BASE

Key for JSON variable Base

See Also:

Constant Field Values

JSON_CITY_ID

private final java.lang.String JSON_CITY_ID

Key for JSON variable City code (ID)

See Also:

Constant Field Values

JSON_CITY_NAME

private final java.lang.String JSON_CITY_NAME

Key for JSON variable City name

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

base

private final java.lang.String base

Base

cityID

private final long cityID

City code (ID)

cityName

private final java.lang.String cityName

City name

responseCode

private final int responseCode

Response code

clouds

private final CurrentWeatherData.Clouds clouds

coord

private final CurrentWeatherData.Coord coord

main

private final CurrentWeatherData.Main main

rain

private final CurrentWeatherData.Rain rain

sys

private final CurrentWeatherData.Sys sys

wind

private final CurrentWeatherData.Wind wind

weatherList

private final java.util.List<CurrentWeatherData.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

CurrentWeatherData

public CurrentWeatherData(org.json.JSONObject jsonObj)

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

Parameters:

jsonObj - JSON object containing current weather data

Method Detail

hasBaseStation

public boolean hasBaseStation()

hasCityCode

public boolean hasCityCode()

hasCityName

public boolean hasCityName()

hasResponseCode

public boolean hasResponseCode()

getBaseStation

public java.lang.String getBaseStation()

getCityCode

public long getCityCode()

getCityName

public java.lang.String getCityName()

getResponseCode

public int getResponseCode()

getClouds_Object

public CurrentWeatherData.Clouds getClouds_Object()

getCoordinates_Object

public CurrentWeatherData.Coord getCoordinates_Object()

getMainData_Object

public CurrentWeatherData.Main getMainData_Object()

getRain_Object

public CurrentWeatherData.Rain getRain_Object()

getSysData_Object

public CurrentWeatherData.Sys getSysData_Object()

getWind_Object

public CurrentWeatherData.Wind getWind_Object()

hasWeather_List

public boolean hasWeather_List()

getWeather_List_Count

public int getWeather_List_Count()

getWeather_List

public java.util.List<CurrentWeatherData.Weather> getWeather_List()