|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectweather_service.weatherprovider.Weather_20_XMLParser
public class Weather_20_XMLParser
Parser for WeatherChannel 2.0 weather service. This class parses responses for "local" queries only and not for:
Field Summary | |
---|---|
static java.lang.String |
BAROMETRIC_PRESSURE
|
static java.lang.String |
CURRENT_CONDITIONS
|
static java.lang.String |
DAY
|
static java.lang.String |
DAY_DATE
|
static java.lang.String |
DAY_INDEX
|
static java.lang.String |
DAY_OF_WEEK
|
static java.lang.String |
DAY_OR_NIGHT
|
static java.lang.String |
DAY_PART
|
static java.lang.String |
DAY_PART_DAY
|
static java.lang.String |
DAY_PART_NIGHT
|
static java.lang.String |
DESCRIPTION
|
static java.lang.String |
DEWPOINT
|
static java.lang.String |
DISPLAY_NAME
|
static java.lang.String |
DISTANCE_UNIT
|
static java.lang.String |
ERROR
|
static java.lang.String |
ERROR_ROOT
|
static java.lang.String |
ERROR_TYPE_ATTRIB
|
static java.lang.String |
FEELS_LIKE_TEMP
|
static java.lang.String |
FORECAST
|
static java.lang.String |
FORM
|
static java.lang.String |
HEAD
|
static java.lang.String |
HIGH_TEMP
|
static java.lang.String |
HUMIDITY
|
static java.lang.String |
ICON
|
static java.lang.String |
INVALID_LICENSE_KEY
|
static java.lang.String |
INVALID_LOCATION_PROVIDED_ERROR
|
static java.lang.String |
INVALID_PARTNERID_ERROR
|
static java.lang.String |
INVALID_PRODUCT_CODE
|
static java.lang.String |
LAST_UPDATED
|
static java.lang.String |
LATITUDE
|
static java.lang.String |
LOCAL_TIME
|
static java.lang.String |
LOCALE
|
static java.lang.String |
LOCATION
|
static java.lang.String |
LOCATION_ID
|
static java.lang.String |
LONGITUDE
|
static java.lang.String |
LOW_TEMP
|
static java.lang.String |
NO_ERROR_TYPE_SET
|
static java.lang.String |
NO_LOCATION_PROVIDED_ERROR
|
static java.lang.String |
OBSERVATION_STATION
|
static java.lang.String |
PRECIPITATION_CHANCE
|
static java.lang.String |
PRECIPITATION_UNIT
|
static java.lang.String |
PRESSURE
|
static java.lang.String |
PRESSURE_TREND
|
static java.lang.String |
PRESSURE_UNIT
|
static java.lang.String |
SEARCH_LOCATION_ATTRIBUTE_ID
|
static java.lang.String |
SEARCH_LOCATION_ATTRIBUTE_TYPE
|
static java.lang.String |
SEARCH_LOCATION_ELEMENT
|
static java.lang.String |
SEARCH_ROOT
|
static java.lang.String |
SEARCH_VERSION_ATTRIBUTE
|
static java.lang.String |
SEARCH_VERSION_ATTRIBUTE_VALUE
|
static java.lang.String |
SPEED_UNIT
|
static java.lang.String |
SUNRISE_TIME
|
static java.lang.String |
SUNSET_TIME
|
static java.lang.String |
TEMPERATURE
|
static java.lang.String |
TEMPERATURE_UNIT
|
static java.lang.String |
TIMEZONE
|
static java.lang.String |
UNKNOWN_ERROR
|
static java.lang.String |
UV
|
static java.lang.String |
UV_DESCRIPTION
|
static java.lang.String |
UV_INDEX
|
static java.lang.String |
VERSION
|
static java.lang.String |
VISIBILITY
|
static java.lang.String |
WEATHER_RESPONSE_VERSION
|
static java.lang.String |
WEATHER_ROOT
|
static java.lang.String |
WIND
|
static java.lang.String |
WIND_DEGREES
|
static java.lang.String |
WIND_DIRECTION
|
static java.lang.String |
WIND_GUST_SPEED
|
static java.lang.String |
WIND_SPEED
|
Constructor Summary | |
---|---|
Weather_20_XMLParser()
|
Method Summary | |
---|---|
java.lang.String |
getType()
|
boolean |
isMyType(org.jdom.Document document)
run this method only on documents returned by the "local" method (of Weather.com). |
protected BarometricPressure |
parseBarometricPressure(org.jdom.Element root)
|
protected CurrentConditions |
parseCurrentConditions(org.jdom.Element root)
Parses the root element of a WeatherChannel looking for Current Conditions. |
protected Day |
parseDay(org.jdom.Element dayRoot)
|
protected DayPart |
parseDayPart(org.jdom.Element dayPartRoot)
|
protected void |
parseError(org.jdom.Element root)
In case of an error, throw WeatherError exception. |
protected Forecast |
parseForecast(org.jdom.Element weatherRoot)
Parses the root element of a WeatherChannel looking for the Forecast. |
protected Header |
parseHeader(org.jdom.Element weatherRoot)
Parses the root element of a WeatherChannel looking for the Header. |
protected Location |
parseLocation(org.jdom.Element weatherRoot)
Parses the root element of a WeatherChannel looking for the Location. |
protected SearchLocation |
parseSearchLocation(org.jdom.Element locationElement)
|
protected SearchLocations |
parseSearchQuery(org.jdom.Document document)
|
protected UltraViolet |
parseUV(org.jdom.Element root)
|
WeatherReport |
parseWeatherQuery(org.jdom.Document document,
boolean validate)
this method actually parses the "local" query's response document into a WeatherReport object. |
protected WeatherReport |
parseWeatherResponse(org.jdom.Element root)
Parses the root element of a JDOM document into a WeatherChannel bean. |
protected Wind |
parseWind(org.jdom.Element windRoot)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String WEATHER_ROOT
public static final java.lang.String VERSION
public static final java.lang.String WEATHER_RESPONSE_VERSION
public static final java.lang.String HEAD
public static final java.lang.String LOCALE
public static final java.lang.String FORM
public static final java.lang.String TEMPERATURE_UNIT
public static final java.lang.String DISTANCE_UNIT
public static final java.lang.String SPEED_UNIT
public static final java.lang.String PRECIPITATION_UNIT
public static final java.lang.String PRESSURE_UNIT
public static final java.lang.String LOCATION
public static final java.lang.String LOCATION_ID
public static final java.lang.String DISPLAY_NAME
public static final java.lang.String LOCAL_TIME
public static final java.lang.String LATITUDE
public static final java.lang.String LONGITUDE
public static final java.lang.String SUNRISE_TIME
public static final java.lang.String SUNSET_TIME
public static final java.lang.String TIMEZONE
public static final java.lang.String CURRENT_CONDITIONS
public static final java.lang.String LAST_UPDATED
public static final java.lang.String OBSERVATION_STATION
public static final java.lang.String TEMPERATURE
public static final java.lang.String FEELS_LIKE_TEMP
public static final java.lang.String DESCRIPTION
public static final java.lang.String ICON
public static final java.lang.String BAROMETRIC_PRESSURE
public static final java.lang.String PRESSURE
public static final java.lang.String PRESSURE_TREND
public static final java.lang.String WIND
public static final java.lang.String WIND_SPEED
public static final java.lang.String WIND_GUST_SPEED
public static final java.lang.String WIND_DEGREES
public static final java.lang.String WIND_DIRECTION
public static final java.lang.String HUMIDITY
public static final java.lang.String VISIBILITY
public static final java.lang.String UV
public static final java.lang.String UV_INDEX
public static final java.lang.String UV_DESCRIPTION
public static final java.lang.String DEWPOINT
public static final java.lang.String FORECAST
public static final java.lang.String DAY
public static final java.lang.String DAY_PART
public static final java.lang.String DAY_OR_NIGHT
public static final java.lang.String DAY_PART_DAY
public static final java.lang.String DAY_PART_NIGHT
public static final java.lang.String HIGH_TEMP
public static final java.lang.String LOW_TEMP
public static final java.lang.String PRECIPITATION_CHANCE
public static final java.lang.String DAY_INDEX
public static final java.lang.String DAY_OF_WEEK
public static final java.lang.String DAY_DATE
public static final java.lang.String ERROR_ROOT
public static final java.lang.String ERROR
public static final java.lang.String ERROR_TYPE_ATTRIB
public static final java.lang.String NO_ERROR_TYPE_SET
public static final java.lang.String UNKNOWN_ERROR
public static final java.lang.String NO_LOCATION_PROVIDED_ERROR
public static final java.lang.String INVALID_LOCATION_PROVIDED_ERROR
public static final java.lang.String INVALID_PARTNERID_ERROR
public static final java.lang.String INVALID_PRODUCT_CODE
public static final java.lang.String INVALID_LICENSE_KEY
public static final java.lang.String SEARCH_ROOT
public static final java.lang.String SEARCH_VERSION_ATTRIBUTE
public static final java.lang.String SEARCH_VERSION_ATTRIBUTE_VALUE
public static final java.lang.String SEARCH_LOCATION_ELEMENT
public static final java.lang.String SEARCH_LOCATION_ATTRIBUTE_ID
public static final java.lang.String SEARCH_LOCATION_ATTRIBUTE_TYPE
Constructor Detail |
---|
public Weather_20_XMLParser()
Method Detail |
---|
protected SearchLocations parseSearchQuery(org.jdom.Document document) throws WeatherError, java.lang.NullPointerException
document
-
WeatherError
java.lang.NullPointerException
- - if some of the elements or attributes are not found, then this exception can be thrown,
which implies there is a parsing issue (which will be thrown by the caller of this method)protected SearchLocation parseSearchLocation(org.jdom.Element locationElement)
public boolean isMyType(org.jdom.Document document) throws WeatherError
document
- - only pass it documents that contain responses from the "local" method; no not pass "error" or "search" responses
WeatherError
- - if there is some problem parsing the document then it throws a WeatherError.WEATHER_PARSING_ERRORpublic WeatherReport parseWeatherQuery(org.jdom.Document document, boolean validate) throws WeatherError
document
- validate
-
WeatherError
public java.lang.String getType()
protected WeatherReport parseWeatherResponse(org.jdom.Element root)
root
- the root element of the JDOM document to parse.
protected Header parseHeader(org.jdom.Element weatherRoot)
weatherRoot
- the root element of the document to parse for the Header.
protected Location parseLocation(org.jdom.Element weatherRoot)
weatherRoot
- the root element of the document to parse for the Location.
protected Forecast parseForecast(org.jdom.Element weatherRoot)
weatherRoot
- the root element of the document to parse for the Forecast.
protected CurrentConditions parseCurrentConditions(org.jdom.Element root)
root
- the root element of the document to parse for Current Conditions.
protected Day parseDay(org.jdom.Element dayRoot)
protected DayPart parseDayPart(org.jdom.Element dayPartRoot)
protected Wind parseWind(org.jdom.Element windRoot)
protected BarometricPressure parseBarometricPressure(org.jdom.Element root)
protected UltraViolet parseUV(org.jdom.Element root)
protected void parseError(org.jdom.Element root) throws WeatherError
root
- the root element of the document to parse for the weather.
WeatherError
- - this exception is thrown if a problem is found while parsing the document
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |