doc/JavaDoc/ch/epfl/sdp/peakar/points/GeonamesHandler.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 (1.8.0_242-release) on Fri Jun 04 18:15:39 CEST 2021 -->
<title>GeonamesHandler</title>
<meta name="date" content="2021-06-04">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="GeonamesHandler";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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="../../../../../ch/epfl/sdp/peakar/points/Geonames.html" title="interface in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../ch/epfl/sdp/peakar/points/GPSTracker.html" title="class in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/points/GeonamesHandler.html" target="_top">Frames</a></li>
<li><a href="GeonamesHandler.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: </li>
<li><a href="#nested.classes.inherited.from.class.android.os.AsyncTask">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </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">ch.epfl.sdp.peakar.points</div>
<h2 title="Class GeonamesHandler" class="title">Class GeonamesHandler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>android.os.AsyncTask<java.lang.Void,java.lang.Void,java.util.ArrayList<org.osmdroid.bonuspack.location.POI>></li>
<li>
<ul class="inheritance">
<li>ch.epfl.sdp.peakar.points.GeonamesHandler</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../ch/epfl/sdp/peakar/points/Geonames.html" title="interface in ch.epfl.sdp.peakar.points">Geonames</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">GeonamesHandler</span>
extends android.os.AsyncTask<java.lang.Void,java.lang.Void,java.util.ArrayList<org.osmdroid.bonuspack.location.POI>>
implements <a href="../../../../../ch/epfl/sdp/peakar/points/Geonames.html" title="interface in ch.epfl.sdp.peakar.points">Geonames</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.android.os.AsyncTask">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class android.os.AsyncTask</h3>
<code>android.os.AsyncTask.Status</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </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>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/GeonamesHandler.html#DEFAULT_RANGE_IN_KM">DEFAULT_RANGE_IN_KM</a></span></code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.android.os.AsyncTask">
<!-- -->
</a>
<h3>Fields inherited from class android.os.AsyncTask</h3>
<code>SERIAL_EXECUTOR, THREAD_POOL_EXECUTOR</code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/GeonamesHandler.html#GeonamesHandler-ch.epfl.sdp.peakar.points.Point-android.content.Context-">GeonamesHandler</a></span>(<a href="../../../../../ch/epfl/sdp/peakar/points/Point.html" title="class in ch.epfl.sdp.peakar.points">Point</a> userLocation,
android.content.Context context)</code>
<div class="block">Initializes provider</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/GeonamesHandler.html#GeonamesHandler-ch.epfl.sdp.peakar.points.Point-double-int-int-">GeonamesHandler</a></span>(<a href="../../../../../ch/epfl/sdp/peakar/points/Point.html" title="class in ch.epfl.sdp.peakar.points">Point</a> userLocation,
double boundingBoxRangeKm,
int queryMaxResults,
int queryTimeout)</code>
<div class="block">Class constructor.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>protected java.util.ArrayList<org.osmdroid.bonuspack.location.POI></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/GeonamesHandler.html#doInBackground-java.lang.Void...-">doInBackground</a></span>(java.lang.Void... voids)</code>
<div class="block">returns the query result</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/GeonamesHandler.html#onPostExecute-java.util.ArrayList-">onPostExecute</a></span>(java.util.ArrayList<org.osmdroid.bonuspack.location.POI> pois)</code>
<div class="block">filterPOI : filter out point of interest list.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/GeonamesHandler.html#onPreExecute--">onPreExecute</a></span>()</code>
<div class="block">onPreExecute method.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../ch/epfl/sdp/peakar/points/GeonamesHandler.html#onResponseReceived-java.util.ArrayList-">onResponseReceived</a></span>(java.util.ArrayList<org.osmdroid.bonuspack.location.POI> result)</code>
<div class="block">Callback function called when POI list is received</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.android.os.AsyncTask">
<!-- -->
</a>
<h3>Methods inherited from class android.os.AsyncTask</h3>
<code>cancel, execute, execute, executeOnExecutor, get, get, getStatus, isCancelled, onCancelled, onCancelled, onProgressUpdate, publishProgress</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class 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="DEFAULT_RANGE_IN_KM">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DEFAULT_RANGE_IN_KM</h4>
<pre>public static final int DEFAULT_RANGE_IN_KM</pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#ch.epfl.sdp.peakar.points.GeonamesHandler.DEFAULT_RANGE_IN_KM">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="GeonamesHandler-ch.epfl.sdp.peakar.points.Point-android.content.Context-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>GeonamesHandler</h4>
<pre>public GeonamesHandler(<a href="../../../../../ch/epfl/sdp/peakar/points/Point.html" title="class in ch.epfl.sdp.peakar.points">Point</a> userLocation,
android.content.Context context)</pre>
<div class="block">Initializes provider</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userLocation</code> - Point containing user location inforamtions</dd>
</dl>
</li>
</ul>
<a name="GeonamesHandler-ch.epfl.sdp.peakar.points.Point-double-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>GeonamesHandler</h4>
<pre>public GeonamesHandler(<a href="../../../../../ch/epfl/sdp/peakar/points/Point.html" title="class in ch.epfl.sdp.peakar.points">Point</a> userLocation,
double boundingBoxRangeKm,
int queryMaxResults,
int queryTimeout)</pre>
<div class="block">Class constructor.
Initialises query parameters and OverPassAPIProvider
Initialises result array list</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>userLocation</code> - user location (center of the query bounding box)</dd>
<dd><code>boundingBoxRangeKm</code> - range around the user location to compute the bounding box</dd>
<dd><code>queryMaxResults</code> - max results that the query should return (please do not exceed 500)</dd>
<dd><code>queryTimeout</code> - query timeout</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="onPreExecute--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onPreExecute</h4>
<pre>protected void onPreExecute()</pre>
<div class="block">onPreExecute method.
Setup bounding box for the POI query
Creates the url query</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>onPreExecute</code> in class <code>android.os.AsyncTask<java.lang.Void,java.lang.Void,java.util.ArrayList<org.osmdroid.bonuspack.location.POI>></code></dd>
</dl>
</li>
</ul>
<a name="onPostExecute-java.util.ArrayList-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>onPostExecute</h4>
<pre>protected void onPostExecute(java.util.ArrayList<org.osmdroid.bonuspack.location.POI> pois)</pre>
<div class="block">filterPOI : filter out point of interest list. The result list contains only peaks</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>onPostExecute</code> in class <code>android.os.AsyncTask<java.lang.Void,java.lang.Void,java.util.ArrayList<org.osmdroid.bonuspack.location.POI>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pois</code> - list containing all points of interests around Geopoint</dd>
</dl>
</li>
</ul>
<a name="doInBackground-java.lang.Void...-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>doInBackground</h4>
<pre>protected java.util.ArrayList<org.osmdroid.bonuspack.location.POI> doInBackground(java.lang.Void... voids)</pre>
<div class="block">returns the query result</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>doInBackground</code> in class <code>android.os.AsyncTask<java.lang.Void,java.lang.Void,java.util.ArrayList<org.osmdroid.bonuspack.location.POI>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>voids</code> - nothing</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>list of POI</dd>
</dl>
</li>
</ul>
<a name="onResponseReceived-java.util.ArrayList-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>onResponseReceived</h4>
<pre>public abstract void onResponseReceived(java.util.ArrayList<org.osmdroid.bonuspack.location.POI> result)</pre>
<div class="block">Callback function called when POI list is received</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../ch/epfl/sdp/peakar/points/Geonames.html#onResponseReceived-java.util.ArrayList-">onResponseReceived</a></code> in interface <code><a href="../../../../../ch/epfl/sdp/peakar/points/Geonames.html" title="interface in ch.epfl.sdp.peakar.points">Geonames</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>result</code> - ArrayList containing POI</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</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="../../../../../ch/epfl/sdp/peakar/points/Geonames.html" title="interface in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../../ch/epfl/sdp/peakar/points/GPSTracker.html" title="class in ch.epfl.sdp.peakar.points"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?ch/epfl/sdp/peakar/points/GeonamesHandler.html" target="_top">Frames</a></li>
<li><a href="GeonamesHandler.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: </li>
<li><a href="#nested.classes.inherited.from.class.android.os.AsyncTask">Nested</a> | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>