001: /**
002: * Copyright (c) 2003-2007, David A. Czarnecki
003: * All rights reserved.
004: *
005: * Redistribution and use in source and binary forms, with or without
006: * modification, are permitted provided that the following conditions are met:
007: *
008: * Redistributions of source code must retain the above copyright notice, this list of conditions and the
009: * following disclaimer.
010: * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
011: * following disclaimer in the documentation and/or other materials provided with the distribution.
012: * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
013: * endorse or promote products derived from this software without specific prior written permission.
014: * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
015: * without prior written permission of David A. Czarnecki.
016: *
017: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
018: * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
019: * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
020: * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
021: * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
022: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
023: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
024: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
025: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
026: * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
027: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
028: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
029: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
030: */package org.blojsom.plugin.weather.beans;
031:
032: import org.w3c.dom.Document;
033:
034: /**
035: * WeatherInformation
036: *
037: * @author Mark Lussier
038: * @version $Id: WeatherInformation.java,v 1.2 2007/01/17 02:35:15 czarneckid Exp $
039: * @since blojsom 3.0
040: */
041: public interface WeatherInformation {
042:
043: /**
044: * Parse an XML document containing weather related information
045: *
046: * @param document XML document with weather information
047: */
048: void parseDocument(Document document);
049:
050: /**
051: * Get the current temperature as Farenheit
052: *
053: * @return A String containing the current temperature in Farenheit
054: */
055: String getFahrenheit();
056:
057: /**
058: * Get the current temperate as Celcius
059: *
060: * @return A String containing the current temperature as Celcius
061: */
062: String getCelcius();
063:
064: /**
065: * Get the Location of the Weather Station
066: *
067: * @return The Weather Station name as a String
068: */
069: String getLocation();
070:
071: /**
072: * Get the Station Id
073: *
074: * @return The Station Id as a String
075: */
076: String getStationCode();
077:
078: /**
079: * Get the current Visibility
080: *
081: * @return The current visbility as a String
082: */
083: String getVisibility();
084:
085: /**
086: * Get the current Wind conditions
087: *
088: * @return The current wind conditions as a String
089: */
090: String getWind();
091:
092: /**
093: * Get the URL containing a link to weather history information
094: *
095: * @return URL for weather history information
096: */
097: String getHistoryUrl();
098:
099: /**
100: * Gets the URL required to fetch this resource
101: *
102: * @return The resource location as a String
103: */
104: String getProviderUrl();
105:
106: /**
107: * Get the value for a given tag from the parsed XML weather information
108: *
109: * @param tag Tag to retrieve
110: * @return Value of tag or <code>null</code> if the tag is not present
111: * @since blojsom 2.24
112: */
113: String getValueForTag(String tag);
114: }
|