net.aksingh.java.api.owm

Class AbstractWeatherData

java.lang.Object

net.aksingh.java.api.owm.AbstractWeatherData

Direct Known Subclasses:

CurrentWeatherData, DailyForecastData.Forecast, ForecastWeatherData.Forecast

public abstract class AbstractWeatherData
extends java.lang.Object

This class provides default implementations for CurrentWeatherData and ForecastWeatherData classes. Standard behaviors like the has and the get methods for information about weather or forecast (for example, temperature, pressure, weather, clouds, wind, etc.) are defined here.

Since:

2.5.0.1

Version:

2013/07/26

Author:

Ashutosh Kumar Singh

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractWeatherData.Clouds This class provides default implementations for Clouds.
static class	AbstractWeatherData.Coord This class provides default implementations for Coord.
static class	AbstractWeatherData.Main This class provides default implementations for Main.
static class	AbstractWeatherData.Weather This class provides default implementations for Weather.
static class	AbstractWeatherData.Wind This class provides default implementations for Wind.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Date	dateTime Date and time of the weather.
protected java.lang.String	JSON_CLOUDS Key for JSON object - Clouds
protected java.lang.String	JSON_COORD Key for JSON object - Coordinates (Geographic coordinates)
private java.lang.String	JSON_DATE_TIME Key for JSON variable Date-Time (date & time of the weather)
protected java.lang.String	JSON_MAIN Key for JSON object - Main (Temperature, pressure, etc.)
protected java.lang.String	JSON_WEATHER Key for JSON array - Weather (Weather name, description, etc.)
protected java.lang.String	JSON_WIND Key for JSON object - Wind

Constructor Summary

Constructors

Constructor and Description
AbstractWeatherData() Non-parameterized constructor
AbstractWeatherData(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.util.Date	getDateTime() Returns data for date and time of this weather.
boolean	hasDateTime() Tells if the data for date and time of this weather is available or not.

Methods inherited from class java.lang.Object

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

Field Detail

JSON_CLOUDS

protected final java.lang.String JSON_CLOUDS

Key for JSON object - Clouds

See Also:

Constant Field Values

JSON_COORD

protected final java.lang.String JSON_COORD

Key for JSON object - Coordinates (Geographic coordinates)

See Also:

Constant Field Values

JSON_MAIN

protected final java.lang.String JSON_MAIN

Key for JSON object - Main (Temperature, pressure, etc.)

See Also:

Constant Field Values

JSON_WEATHER

protected final java.lang.String JSON_WEATHER

Key for JSON array - Weather (Weather name, description, etc.)

See Also:

Constant Field Values

JSON_WIND

protected final java.lang.String JSON_WIND

Key for JSON object - Wind

See Also:

Constant Field Values

JSON_DATE_TIME

private final java.lang.String JSON_DATE_TIME

Key for JSON variable Date-Time (date & time of the weather)

See Also:

Constant Field Values

dateTime

private final java.util.Date dateTime

Date and time of the weather. This is answer for the question that when is/will be this weather.

Constructor Detail

AbstractWeatherData

public AbstractWeatherData()

Non-parameterized constructor

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

AbstractWeatherData

public AbstractWeatherData(org.json.JSONObject jsonObj)

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

Parameters:

jsonObj - JSON object containing weather data

Method Detail

hasDateTime

public boolean hasDateTime()

Tells if the data for date and time of this weather is available or not.

Returns:

true if data available, otherwise false

getDateTime

public java.util.Date getDateTime()

Returns data for date and time of this weather.

Returns:

Date and time (in object of Date) if available, otherwise null