1
0
Fork 0
mirror of https://bitbucket.org/ethauvin/owm-japis.git synced 2025-04-25 01:47:10 -07:00
owm-japis-bak/javadoc/net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html
Ashutosh Kumar Singh de1786a2d9 2.5.0.1 is ready!
2013-08-10 23:52:09 +05:30

511 lines
20 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_17) on Sat Aug 10 23:46:35 IST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ForecastWeatherData.Forecast.Main (OpenWeatherMap.org JAPIs)</title>
<meta name="date" content="2013-08-10">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ForecastWeatherData.Forecast.Main (OpenWeatherMap.org JAPIs)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../net/aksingh/java/api/owm/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ForecastWeatherData.Forecast.Main.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Clouds.html" title="class in net.aksingh.java.api.owm"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Sys.html" title="class in net.aksingh.java.api.owm"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html" target="_top">Frames</a></li>
<li><a href="ForecastWeatherData.Forecast.Main.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">net.aksingh.java.api.owm</div>
<h2 title="Class ForecastWeatherData.Forecast.Main" class="title">Class ForecastWeatherData.Forecast.Main</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html" title="class in net.aksingh.java.api.owm">net.aksingh.java.api.owm.AbstractWeatherData.Main</a></li>
<li>
<ul class="inheritance">
<li>net.aksingh.java.api.owm.ForecastWeatherData.Forecast.Main</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.html" title="class in net.aksingh.java.api.owm">ForecastWeatherData.Forecast</a></dd>
</dl>
<hr>
<br>
<pre>public static class <span class="strong">ForecastWeatherData.Forecast.Main</span>
extends <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html" title="class in net.aksingh.java.api.owm">AbstractWeatherData.Main</a></pre>
<div class="block">Parses data about main weather elements (from the JSON data)
and provides methods to get/access the information.
For example, temperature, pressure, sea level, etc.
This class provides <code>has</code> and <code>get</code> methods
to access the information.
<p><code>has</code> methods can be used to check
if the data exists, i.e., if the data was available (successfully
downloaded) and was parsed correctly.
<p><code>get</code> methods can be used to access the data, if the data
exists, otherwise <code>get</code> methods will give value as per
following basis:<br>
Boolean: <code>false</code><br>
Integral: Minimum value (MIN_VALUE)<br>
Floating point: Not a number (NaN)<br>
Others: <code>null</code><br></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.5.0.1</dd>
<dt><span class="strong">Version:</span></dt>
<dd>2013/08/07</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Ashutosh Kumar Singh</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private float</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#groundLevel">groundLevel</a></strong></code>
<div class="block">Ground level</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#JSON_MAIN_GRND_LEVEL">JSON_MAIN_GRND_LEVEL</a></strong></code>
<div class="block">Key for JSON variable <code>Main -> Ground level</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#JSON_MAIN_SEA_LEVEL">JSON_MAIN_SEA_LEVEL</a></strong></code>
<div class="block">Key for JSON variable <code>Main -> Sea level</code></div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#JSON_MAIN_TMP_KF">JSON_MAIN_TMP_KF</a></strong></code>
<div class="block">Key for JSON variable <code>Main -> Temperature KF</code></div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private float</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#seaLevel">seaLevel</a></strong></code>
<div class="block">Sea level</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private float</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#tempKF">tempKF</a></strong></code>
<div class="block">Temperature KF</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#ForecastWeatherData.Forecast.Main()">ForecastWeatherData.Forecast.Main</a></strong>()</code>
<div class="block">Non-parameterized constructor</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#ForecastWeatherData.Forecast.Main(org.json.JSONObject)">ForecastWeatherData.Forecast.Main</a></strong>(org.json.JSONObject&nbsp;jsonObj)</code>
<div class="block">Parameterized constructor
Initializes variables from values from the given JSON object.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#getGroundLevel()">getGroundLevel</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#getSeaLevel()">getSeaLevel</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#getTempKF()">getTempKF</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#hasGroundLevel()">hasGroundLevel</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#hasSeaLevel()">hasSeaLevel</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html#hasTempKF()">hasTempKF</a></strong>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_net.aksingh.java.api.owm.AbstractWeatherData.Main">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;net.aksingh.java.api.owm.<a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html" title="class in net.aksingh.java.api.owm">AbstractWeatherData.Main</a></h3>
<code><a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#getHumidity()">getHumidity</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#getMaxTemperature()">getMaxTemperature</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#getMinTemperature()">getMinTemperature</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#getPressure()">getPressure</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#getTemperature()">getTemperature</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#hasHumidity()">hasHumidity</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#hasMaxTemperature()">hasMaxTemperature</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#hasMinTemperature()">hasMinTemperature</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#hasPressure()">hasPressure</a>, <a href="../../../../../net/aksingh/java/api/owm/AbstractWeatherData.Main.html#hasTemperature()">hasTemperature</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="JSON_MAIN_SEA_LEVEL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_MAIN_SEA_LEVEL</h4>
<pre>private final&nbsp;java.lang.String JSON_MAIN_SEA_LEVEL</pre>
<div class="block">Key for JSON variable <code>Main -> Sea level</code></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.ForecastWeatherData.Forecast.Main.JSON_MAIN_SEA_LEVEL">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JSON_MAIN_GRND_LEVEL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_MAIN_GRND_LEVEL</h4>
<pre>private final&nbsp;java.lang.String JSON_MAIN_GRND_LEVEL</pre>
<div class="block">Key for JSON variable <code>Main -> Ground level</code></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.ForecastWeatherData.Forecast.Main.JSON_MAIN_GRND_LEVEL">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="JSON_MAIN_TMP_KF">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>JSON_MAIN_TMP_KF</h4>
<pre>private final&nbsp;java.lang.String JSON_MAIN_TMP_KF</pre>
<div class="block">Key for JSON variable <code>Main -> Temperature KF</code></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#net.aksingh.java.api.owm.ForecastWeatherData.Forecast.Main.JSON_MAIN_TMP_KF">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="seaLevel">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>seaLevel</h4>
<pre>private final&nbsp;float seaLevel</pre>
<div class="block">Sea level</div>
</li>
</ul>
<a name="groundLevel">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>groundLevel</h4>
<pre>private final&nbsp;float groundLevel</pre>
<div class="block">Ground level</div>
</li>
</ul>
<a name="tempKF">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>tempKF</h4>
<pre>private final&nbsp;float tempKF</pre>
<div class="block">Temperature KF</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ForecastWeatherData.Forecast.Main()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ForecastWeatherData.Forecast.Main</h4>
<pre>public&nbsp;ForecastWeatherData.Forecast.Main()</pre>
<div class="block">Non-parameterized constructor
<p>Initializes variables as per following basis:<br>
Boolean: <code>false</code><br>
Integral: Minimum value (MIN_VALUE)<br>
Floating point: Not a number (NaN)<br>
Others: <code>null</code><br></div>
</li>
</ul>
<a name="ForecastWeatherData.Forecast.Main(org.json.JSONObject)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ForecastWeatherData.Forecast.Main</h4>
<pre>public&nbsp;ForecastWeatherData.Forecast.Main(org.json.JSONObject&nbsp;jsonObj)</pre>
<div class="block">Parameterized constructor
Initializes variables from values from the given JSON object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>jsonObj</code> - JSON object containing data about main
weather elements</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="hasSeaLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasSeaLevel</h4>
<pre>public&nbsp;boolean&nbsp;hasSeaLevel()</pre>
</li>
</ul>
<a name="hasGroundLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasGroundLevel</h4>
<pre>public&nbsp;boolean&nbsp;hasGroundLevel()</pre>
</li>
</ul>
<a name="hasTempKF()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasTempKF</h4>
<pre>public&nbsp;boolean&nbsp;hasTempKF()</pre>
</li>
</ul>
<a name="getSeaLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSeaLevel</h4>
<pre>public&nbsp;float&nbsp;getSeaLevel()</pre>
</li>
</ul>
<a name="getGroundLevel()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGroundLevel</h4>
<pre>public&nbsp;float&nbsp;getGroundLevel()</pre>
</li>
</ul>
<a name="getTempKF()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTempKF</h4>
<pre>public&nbsp;float&nbsp;getTempKF()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../net/aksingh/java/api/owm/package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ForecastWeatherData.Forecast.Main.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Clouds.html" title="class in net.aksingh.java.api.owm"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Sys.html" title="class in net.aksingh.java.api.owm"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?net/aksingh/java/api/owm/ForecastWeatherData.Forecast.Main.html" target="_top">Frames</a></li>
<li><a href="ForecastWeatherData.Forecast.Main.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>