WeatherInformation


1   /**
2    * Copyright (c) 2003-2006, David A. Czarnecki
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions are met:
7    *
8    * Redistributions of source code must retain the above copyright notice, this list of conditions and the
9    *     following disclaimer.
10   * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
11   *     following disclaimer in the documentation and/or other materials provided with the distribution.
12   * Neither the name of "David A. Czarnecki" and "blojsom" nor the names of its contributors may be used to
13   *     endorse or promote products derived from this software without specific prior written permission.
14   * Products derived from this software may not be called "blojsom", nor may "blojsom" appear in their name,
15   *     without prior written permission of David A. Czarnecki.
16   *
17   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
18   * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
19   * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20   * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
21   * EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
22   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24   * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26   * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29   * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  package org.blojsom.plugin.weather.beans;
32  
33  import org.w3c.dom.Document  ;
34  
35  
36  /**
37   * WeatherInformation
38   *
39   * @author Mark Lussier
40   * @version $Id: WeatherInformation.java,v 1.1 2006/03/26 16:27:30 czarneckid Exp $
41   * @since blojsom 3.0
42   */
43  public interface WeatherInformation {
44  
45      /**
46       * Parse an XML document containing weather related information
47       *
48       * @param document XML document with weather information
49       */
50      void parseDocument(Document   document);
51  
52      /**
53       * Get the current temperature as Farenheit
54       *
55       * @return A String containing the current temperature in Farenheit
56       */
57      String   getFahrenheit();
58  
59      /**
60       * Get the current temperate as Celcius
61       *
62       * @return A String containing the current temperature as Celcius
63       */
64      String   getCelcius();
65  
66      /**
67       * Get the Location of the Weather Station
68       *
69       * @return The Weather Station name as a String
70       */
71      String   getLocation();
72  
73      /**
74       * Get the Station Id
75       *
76       * @return The Station Id as a String
77       */
78      String   getStationCode();
79  
80      /**
81       * Get the current Visibility
82       *
83       * @return The current visbility as a String
84       */
85      String   getVisibility();
86  
87      /**
88       * Get the current Wind conditions
89       *
90       * @return The current wind conditions as a String
91       */
92      String   getWind();
93  
94      /**
95       * Get the URL containing a link to weather history information
96       *
97       * @return URL for weather history information
98       */
99      String   getHistoryUrl();
100 
101     /**
102      * Gets the URL required to fetch this resource
103      *
104      * @return The resource location as a String
105      */
106     String   getProviderUrl();
107 
108     /**
109      * Get the value for a given tag from the parsed XML weather information
110      *
111      * @param tag Tag to retrieve
112      * @return Value of tag or <code>null</code> if the tag is not present
113      * @since blojsom 2.24
114      */
115     String   getValueForTag(String   tag);
116 }
117
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags