net.aksingh.java.api.owm

Class DailyForecastData.City

java.lang.Object

net.aksingh.java.api.owm.DailyForecastData.City

Enclosing class:

DailyForecastData

public static class DailyForecastData.City
extends java.lang.Object

Parses data about city (from the JSON data) and provides methods to get/access the information. For example, city name, coordinates, country name, population, etc. 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	DailyForecastData.City.Coord Parses data about geographic coordinates (from the JSON data) and provides methods to get/access the information.

Field Summary

Fields

Modifier and Type	Field and Description
private long	cityID City code (ID)
private java.lang.String	cityName City name
private DailyForecastData.City.Coord	coord
private java.lang.String	countryCode Country code of city
private java.lang.String	JSON_CITY_COORD Key for JSON object - Coordinates
private java.lang.String	JSON_CITY_COUNTRY_CODE Key for JSON variable Country code of city
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_CITY_POPULATION Key for JSON variable Population of city
private long	population Population of city

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
long	getCityCode()
java.lang.String	getCityName()
long	getCityPopulation()
DailyForecastData.City.Coord	getCoordinates_Object()
java.lang.String	getCountryCode()
boolean	hasCityCode()
boolean	hasCityName()
boolean	hasCityPopulation()
boolean	hasCountryCode()

Methods inherited from class java.lang.Object

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

Field Detail

JSON_CITY_COORD

private final java.lang.String JSON_CITY_COORD

Key for JSON object - Coordinates

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_CITY_COUNTRY_CODE

private final java.lang.String JSON_CITY_COUNTRY_CODE

Key for JSON variable Country code of city

See Also:

Constant Field Values

JSON_CITY_POPULATION

private final java.lang.String JSON_CITY_POPULATION

Key for JSON variable Population of city

See Also:

Constant Field Values

cityID

private final long cityID

City code (ID)

cityName

private final java.lang.String cityName

City name

countryCode

private final java.lang.String countryCode

Country code of city

population

private final long population

Population of city

coord

private final DailyForecastData.City.Coord coord

Constructor Detail

DailyForecastData.City

public DailyForecastData.City()

Non-parameterized constructor

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

DailyForecastData.City

public DailyForecastData.City(org.json.JSONObject jsonObj)

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

Parameters:

jsonObj - JSON object containing data about city

Method Detail

hasCityCode

public boolean hasCityCode()

hasCityName

public boolean hasCityName()

hasCountryCode

public boolean hasCountryCode()

hasCityPopulation

public boolean hasCityPopulation()

getCityCode

public long getCityCode()

getCityName

public java.lang.String getCityName()

getCountryCode

public java.lang.String getCountryCode()

getCityPopulation

public long getCityPopulation()

getCoordinates_Object

public DailyForecastData.City.Coord getCoordinates_Object()