address-poi-search-by-text-near-gps-position.html

<!--/* NODE-RED-CONTRIB-SNAP4CITY-DEVELOPER
   Copyright (C) 2018 DISIT Lab http://www.disit.org - University of Florence

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Affero General Public License as
   published by the Free Software Foundation, either version 3 of the
   License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Affero General Public License for more details.

   You should have received a copy of the GNU Affero General Public License
   along with this program.  If not, see <http://www.gnu.org/licenses/>. */-->
<script type="text/javascript">
    RED.nodes.registerType('address-poi-search-by-text-near-gps-position', {
        category: 'S4CSearchDev',
        color: '#E7E7AE',
        defaults: {
            name: {
                value: ""
            },
            authentication: {
                type: "snap4city-authentication",
                required: false
            },
            search: {
                value: "",
                required: false
            },
            latitude: {
                value: 0.0,
                required: false,
                validate: RED.validators.number()
            },
            longitude: {
                value: 0.0,
                required: false,
                validate: RED.validators.number()
            },
            maxdists: {
                value: 1,
                required: false,
                validate: RED.validators.number()
            },
            maxresults: {
                value: 100,
                required: false,
                validate: RED.validators.number()
            }
        },
        outputs: 2,
        inputs: 1,
        icon: "white-globe.png",
        label: function () {
            return this.name || "address-poi-search-by-text-near-gps-position";
        }
    });
</script>

<script type="text/x-red" data-template-name="address-poi-search-by-text-near-gps-position">
    <div class="form-row" id="rowAuthentication">
        <label for="node-input-authentication">Authentication</label>
        <input type="text" id="node-input-authentication">
    </div>
    <div class="form-tips"  id="tipAuthentication" style="margin-bottom: 10px;">
        If you have private data and you want to access them, you must have to insert you account data. You can register for one account 
        <a href="https://www.snap4city.org"
            target="_blank">here</a>.
    </div>
    <div class="form-row">
        <label for="node-input-name">Name</label>
        <input type="text" autocomplete="off" id="node-input-name" placeholder="Name">
    </div>
    <div class="form-row">
        <label for="node-input-search">Search Text</label>
        <input type="text" autocomplete="off" id="node-input-search" placeholder="Search Text">
    </div>
    <div class="form-row">
        <label for="node-input-latitude">Latitude</label>
        <input type="text" autocomplete="off" id="node-input-latitude" placeholder="Latitude">
    </div>
    <div class="form-row">
        <label for="node-input-longitude">Longitude</label>
        <input type="text" autocomplete="off" id="node-input-longitude" placeholder="Longitude">
    </div>
    <div class="form-row">
        <label for="node-input-maxdists">Max Distance (in km)</label>
        <input type="text" autocomplete="off" id="node-input-maxdists" placeholder="Max Distance">
    </div>
    <div class="form-row">
        <label for="node-input-maxresults">Max Results (0 for all Results)</label>
        <input type="text" autocomplete="off" id="node-input-maxresults" placeholder="Max Results">
    </div>
</script>

<script type="text/x-red" data-help-name="address-poi-search-by-text-near-gps-position">
    <p>it allows to retrieve a list of street addresses and service names based on a text search. The search may be filtered
        excluding POIs and to be within a maximum distance from a GPS position.</p>

    <h3>Inputs</h3>
    A JSON with these parameters:

    <dl class="message-properties">
        <dt>search
            <span class="property-type">string</span>
        </dt>
        <dd> the keywords separated with spaces that have to match with any textual description associated with an entity.</dd>
        <dt>latitude
            <span class="property-type">number</span>
        </dt>
        <dd> latitude of a GPS position</dd>
        <dt>longitude
            <span class="property-type">number</span>
        </dt>
        <dd> longitude of a GPS position</dd>
        <dt>maxdistance
            <span class="property-type">number</span>
        </dt>
        <dd> maximum distance from the GPS position of the services to be retrieved, expressed in Km (0.1 is used if parameter
            is missing) if it is equal to “inside” it searches for services with a WKT geometry that contains the specified
            GPS position (e.g a park)</dd>
        <dt>maxresults
            <span class="property-type">number</span>
        </dt>
        <dd> maximum number of results to be returned (if parameter is missing 100 is assumed), if it is 0 all results are returned</dd>
    </dl>

    <h3>Outputs</h3>
    <ol class="node-ports">
        <li>ServiceUri Array
            <dl class="message-properties">
                <dd> Returns an array containing the servicesUri of each service found</dd>
            </dl>
        </li>
        <li>GeoJSON Results
            <dl class="message-properties">
                <dd> A GeoJSON FeatureCollection object with the matching objects</dd>
            </dl>
        </li>
    </ol>

    <h3>Details</h3>
    <p>The node can receive a JSON with the parameters described in the Inputs section and with them generate the output JSON.
        If the values are not present in the input JSON, these are read by those in the configuration. If they are not present
        in either part, an error is generated for the necessary parameters.</p>

</script>