root/tools/routingservice/trunk/src/jp/co/orkney/restlet/geo/DrivingDistance.java

/**
 * Copyright (c) 2007 Orkney, Inc. <http://www.orkney.co.jp/>
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU 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 General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package jp.co.orkney.restlet.geo;

import java.sql.ResultSet;
import java.sql.SQLException;

import org.antlr.stringtemplate.StringTemplate;
import org.json.JSONException;

import jp.co.orkney.restlet.util.Configuration;
import jp.co.orkney.restlet.util.DatabaseConnection;
import jp.co.orkney.restlet.util.IOHelper;
import jp.co.orkney.restlet.util.Log;
import jp.co.orkney.restlet.util.Point;

/**
 * <b>DrivingDistance is a class which represents a "driving distance isoline"
 * algorithm.</b>
 * <p>
 * "driving distance" algorithm follows these steps:
 * <ul>
 * <li>Extract X and Y</li>
 * <li>Start the database connection</li>
 * <li>Make the query</li>
 * <li>Send the query to the database</li>
 * <li>Transform the result in the specified format</li>
 * <li>Close the database connection</li>
 * </ul>
 * To do these steps, DrivingDistance class calls some method in IOHelper and
 * DatabaseConnection
 * </p>
 * 
 * @author Matthieu Bilbille - Orkney Inc.
 * @version 1.0
 * @see IOHelper
 * @see DatabaseConnection
 */
public class DrivingDistance extends GeoAction
{
        private float speed;
        private float time;
        private float length;


        /**
         * Constructor DrivingDistance
         * <p>
         * Creates a new DrivingDistance object using the specified Configuration
         * object and extracts X and Y from the data provides by GET or POST request
         * into a new point.
         * </p>
         * 
         * @param configuration
         *            the current configuration
         */
        public DrivingDistance(Configuration configuration, DatabaseConnection databaseConnection, IOHelper ioHelper, Log log)
        {
                super(configuration, databaseConnection, ioHelper, log);
                
                name = "Driving distance";

                // extract method for Geojson format
                if (this.configuration.getFormatIn().getName().equals("geojson"))
                {
                        point = ioHelper.extractGEOJSONPxPy(this.configuration.getService().getParameter("point").getValue());
                }
                // extract method for Gml format
                else if (this.configuration.getFormatIn().getName().equals("gml"))
                {
                        point = ioHelper.extractGMLPxPy(this.configuration.getService().getParameter("point").getValue());
                }
                // extract method for lonlat format
                else if (this.configuration.getFormatIn().getName().equals("lonlat"))
                {
                        point = ioHelper.extractLONLATPxPy(this.configuration.getService().getParameter("point").getValue());
                }
                // extract method for wkt format
                else if (this.configuration.getFormatIn().getName().equals("wkt"))
                {
                        point = ioHelper.extractWKTPxPy(this.configuration.getService().getParameter("point").getValue());
                }
                // extract method for kml format
                else if (this.configuration.getFormatIn().getName().equals("kml"))
                {
                        point = ioHelper.extractKMLPxPy(this.configuration.getService().getParameter("point").getValue());
                }

                if (this.configuration.getService().getParameter("speed").getValue() != null)
                {
                        speed = Float.parseFloat(this.configuration.getService().getParameter("speed").getValue());
                }
                else
                {
                        speed = 0;
                }

                if (this.configuration.getService().getParameter("time").getValue() != null)
                {
                        time = Float.parseFloat(this.configuration.getService().getParameter("time").getValue());
                }
                else
                {
                        time = 0;
                }

                if (this.configuration.getService().getParameter("length").getValue() != null)
                {
                        length = Float.parseFloat(this.configuration.getService().getParameter("length").getValue());
                }
                else
                {
                        length = 0;
                }
        }

        /**
         * Gets the result of the driving distance algorithm
         * 
         * @return this closest edge's result
         */
        public String get()
        {
                return result;
        }

        /**
         * Starts the "driving distance" algorithm
         * 
         * @throws SQLException
         *             Error to send the query to the database
         * @throws JSONException
         *             Error to transform the result in Geojson format
         */
        public void start() throws SQLException, JSONException
        {
                StringTemplate query = ioHelper.getQuery();
                float bboxSize = Float.parseFloat(configuration.getService().getParameter("bbox").getValue());
                float distance = 0;
                // I can not specify both TIME and LENGTH for driving distance
                // algorithms
                if (time > 0)
                {
                        distance = time * speed;
                }
                else
                {
                        distance = length;
                }
                // Makes the SQL query
                query.setAttribute("sonPx", point.getX());
                query.setAttribute("sonPy", point.getY());
                query.setAttribute("bbox", bboxSize);
                query.setAttribute("distance", distance);
                query.setAttribute("sridProvider", configuration.getService().getDataProjection());
                query.setAttribute("sridIn", configuration.getService().getParameter("sridInput").getValue());
                query.setAttribute("sridOut", configuration.getService().getParameter("sridOutput").getValue());

                // System.out.println(query.toString());
                log.write(query.toString(), 2);
                ResultSet rs = databaseConnection.getResult(configuration.getService(), query.toString());

                String reqId = configuration.getService().getParameter("request_id").getValue();
                
                // Converts the SQL Result in Geojson
                if (configuration.getFormatOut().getName().equals("geojson"))
                {
                        result = ioHelper.drivingDistanceGEOJSONResult(rs, reqId);
                }
                // Converts the SQL Result in HTML
                else if (configuration.getFormatOut().getName().equals("html"))
                {
                        result = ioHelper.drivingDistanceHTMLResult(rs, point, reqId);
                }
                // Converts the SQL Result in XML
                else if (configuration.getFormatOut().getName().equals("xml"))
                {
                        result = ioHelper.drivingDistanceXMLResult(rs, reqId);
                }
                // Converts the SQL Result in GML
                else if (configuration.getFormatOut().getName().equals("gml"))
                {
                        result = ioHelper.drivingDistanceGMLResult(rs, reqId);
                }
                // Converts the SQL Result in WKT
                else if (configuration.getFormatOut().getName().equals("wkt"))
                {
                        result = ioHelper.drivingDistanceWKTResult(rs);
                }
                // Converts the SQL Result in KML
                else if (configuration.getFormatOut().getName().equals("kml"))
                {
                        result = ioHelper.drivingDistanceKMLResult(rs);
                }
        }
}