traininfoservice/db/StationDAO.java

package dk.thoerup.traininfoservice.db;

import java.sql.Array;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.logging.Logger;

import dk.thoerup.android.traininfo.common.StationBean;
import dk.thoerup.android.traininfo.common.StationEntry;

public class StationDAO {
        
        private interface StatementParamSetter {
                public void setParams(PreparedStatement stmt) throws SQLException ;
        }
        private class NullSetter implements StatementParamSetter {
                @Override
                public void setParams(PreparedStatement stmt) throws SQLException {}
        }
        
        public static class NostationException extends Exception {
                private static final long serialVersionUID = 1L;
        }
        
        final static int LOCATION_LIMIT = 8;
        static final Logger logger = Logger.getLogger(StationDAO.class.getName());
        
        
        private StationEntry convertSingleRow(ResultSet res) throws SQLException {
                StationEntry station = new StationEntry();

                station.setId( res.getInt(1) );
                station.setName( res.getString(2) );
                station.setLatitude( res.getDouble(3) );
                station.setLongitude( res.getDouble(4) );
                station.setRegional( res.getString(5) );
                station.setStrain( res.getString(6) );
                station.setMetro( res.getString(7) );
                station.setAddress( res.getString(8) );
                station.setCalcdist( (int)res.getDouble(9) );
                
                station.setIsRegional( station.getRegional() != null );
                station.setIsStrain( station.getStrain() != null );
                station.setIsMetro( station.getMetro() != null );

                return station;
        }

        private StationBean convertResultset(ResultSet res) throws SQLException {
                StationBean stations = new StationBean();
                while (res.next()) {
                        stations.entries.add( convertSingleRow(res) );
                }
                return stations;

        }

        private StationBean fetchStations(String SQL, StatementParamSetter setter) throws SQLException {
                StationBean stations;
                Connection conn = null;
                PreparedStatement stmt = null;
                ResultSet res = null;
                try {
                        conn = DBConnection.getConnection();
                        stmt = conn.prepareStatement(SQL);
                        
                        setter.setParams(stmt);

                        res = stmt.executeQuery();
                        stations = convertResultset(res);

                } finally {
                        if (res != null)
                                res.close();
                        if (stmt != null)
                                stmt.close();
                        if (conn!= null)
                                conn.close();
                }
                return stations;
                
        }

        public StationEntry getById(int id) throws SQLException,NostationException {
                String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog,stationcode_metro,address,0.0 " +
                "FROM trainstations WHERE id=" + id + " AND enabled=true";
                                
                StationBean stations =  fetchStations(SQL, new NullSetter() );
                
                if (stations.entries.size() > 0 ) {
                        return stations.entries.get(0);
                } else {
                        throw new NostationException();
                }
        }
        

        /*
         * this code requires theses statements are run on database in order to do ILIKE searches against aliases (which is defines as array of varchar(64) )
         *     create function rlike(text,text) returns bool as 
         *     'select $2 ilike $1' language sql strict immutable;
         *     create operator ~~~ (procedure = rlike, leftarg = text, rightarg = text, commutator = ~~);
         */
        public StationBean getByNameNormal(final String name) throws SQLException {
                String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, 0.0 " + 
                "FROM trainstations " + 
                "WHERE (name ILIKE ? OR ? ~~~ ANY(aliases)) AND enabled = true " +
                "ORDER BY name ";

                class NameSetter implements StatementParamSetter {
                        @Override
                        public void setParams(PreparedStatement stmt) throws SQLException {
                                stmt.setString(1, name + "%");
                                stmt.setString(2, name + "%");                          
                        }                       
                }
                
                return fetchStations(SQL, new NameSetter() );
        }
        
        
        public StationBean getByNameFuzzy(final String name) throws SQLException {
                String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, 0.0, " +
                "levenshtein(lower(name),lower(?) ) as leven " +
                "FROM trainstations " + 
                "WHERE (levenshtein(lower(name),lower(?) ) <= 3) " +
                "AND  enabled = true " +
                "ORDER BY leven " + 
                "LIMIT 1";

                class NameSetter implements StatementParamSetter {
                        @Override
                        public void setParams(PreparedStatement stmt) throws SQLException {
                                stmt.setString(1, name );
                                stmt.setString(2, name );
                        }                       
                }
                
                StationBean stations = fetchStations(SQL, new NameSetter() );
                stations.fuzzystrmatch = true;
                return stations;
        }
        
        public StationBean getByName(final String name) throws SQLException {
                StationBean stations = getByNameNormal(name);
                
                if (stations.entries.size() == 0) {
                        logger.info("getByName failover: " + name);
                        stations = getByNameFuzzy(name);
                }
                return stations;
        }
        
        
        //Latitude (horizonal), longitude(vertical) so
        // 1 degree latitude is ~ 111320 meters, since the distance between the horizonal lines is always the same 
        // 1 degree longitude is ~111320 meters at equator but gets shorter as we get closer to the poles.
        // the "hack" with max 0.4 degrees latitude and 0.75 degrees longitude is only valid since we only service danish trains,
        // in denmark 0.4dg latitude ~ 44km, 0.75dg longitude ~ 47km

        // the ultra fast method  (and only slightly inaccurate as long as we only cover a limited geographically area)
        // is using an aproximation of the length of 1 latitude degree and 1 longitude degree and just use pythagoras to 
        // calculate the distance:
        //     sqrt( power(abs(latitude-?)*111320, 2) + power(abs(longitude-?)*63000,2) )::int as calcdist 

        public StationBean getByLocationWorker(final double latitude, final double longitude, final boolean geolimit) throws SQLException {
                
                String limitExpression = (geolimit == true) ? "AND abs(latitude-?)<0.4 AND abs(longitude-?)<0.75 " : "";
                
                String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, " + 
                        "earth_distance( earth_coord, ll_to_earth(?,?))::int AS calcdist " + 
                        "FROM trainstations " +
                        "WHERE enabled = true " + limitExpression +
                        "ORDER BY calcdist ASC " + 
                        "LIMIT " + LOCATION_LIMIT;

                
                class LatlongSetter implements StatementParamSetter {
                        @Override
                        public void setParams(PreparedStatement stmt) throws SQLException {
                                stmt.setDouble(1, latitude);
                                stmt.setDouble(2, longitude);
                                if (geolimit == true) {
                                        stmt.setDouble(3, latitude);
                                        stmt.setDouble(4, longitude);
                                }                               
                        }                       
                }
                
                return fetchStations(SQL, new LatlongSetter() );
        }
        
        public StationBean getByLocation(double latitude, double longitude) throws SQLException {
                StationBean result = getByLocationWorker(latitude, longitude, true);
                
                if (result.entries.size() < LOCATION_LIMIT) { //failover
                        logger.info("getByLocation failover: " +latitude + "," + longitude);
                        
                        result = getByLocationWorker(latitude, longitude, false);
                }
                
                return result;
        }
        
        
        public StationBean getByList(String list) throws SQLException {
                String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog,stationcode_metro, address,0.0 " + 
                "FROM trainstations " + 
                "WHERE id IN " + list + " AND enabled = true " +
                "ORDER BY name ";
                
                return fetchStations(SQL, new NullSetter() );
        }
        

        public StationEntry getSimpleByName(final String name) throws SQLException {
                String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, 0.0 " + 
                "FROM trainstations " + 
                "WHERE name = ?  AND enabled = true " +
                "LIMIT 1 ";

                class NameSetter implements StatementParamSetter {
                        @Override
                        public void setParams(PreparedStatement stmt) throws SQLException {
                                stmt.setString(1, name );
                        }                       
                }
                
                StationBean stations = fetchStations(SQL, new NameSetter() );
                
                if (stations.entries.size() == 1) {
                        return stations.entries.get(0);
                } else {
                        return null;
                }
        }
        
        //used to create full dump in order to populate Google Appengine DB
        @Deprecated
        public StationBean dumpAll() throws SQLException {
                
                String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog,stationcode_metro,address,0.0,aliases " +
                                "FROM trainstations WHERE enabled = true ORDER BY id";
                
                Connection conn = null;
                Statement stmt = null;
                ResultSet res = null;           

                
                try {
                        conn = DBConnection.getConnection();

                        stmt = conn.createStatement();
                        res = stmt.executeQuery(SQL);           
                                                
                        // Does mostly the same as convertResultset()
                        StationBean stations = new StationBean();
                        while (res.next()) {
                                StationEntry entry = convertSingleRow(res);
                                
                                Array arr = res.getArray(10);
                                if (arr != null) {
                                        String[] aliases = (String[]) arr.getArray();
                                        entry.setAliases(aliases);
                                }
                                
                                stations.entries.add( entry );
                                
                        }
                        return stations;
                        

                } finally {
                        if (res != null)
                                res.close();
                        if (stmt != null)
                                stmt.close();
                        if (conn != null)
                                conn.close();
                }
                
        }

        @Deprecated
        public static String getStationName(int stationID) {
                String station = "";

                Connection conn = null;
                try {
                        conn = DBConnection.getConnection();
                        Statement stmt = conn.createStatement();
                        ResultSet rs = stmt.executeQuery("SELECT name FROM trainstations WHERE id=" + stationID);
                        if (rs.next()) {
                                station = rs.getString(1);
                        }

                } catch (Exception e) { 
                } finally {
                        try {
                                if (conn != null && !conn.isClosed())
                                        conn.close();
                        } catch (Exception e) {}
                }

                return station;
        }
        
        
        @Deprecated
        public int getIdByName(final String name) throws SQLException {
                String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, 0.0 " + 
                "FROM trainstations " + 
                "WHERE name = ?  AND enabled = true " +
                "LIMIT 1 ";

                class NameSetter implements StatementParamSetter {
                        @Override
                        public void setParams(PreparedStatement stmt) throws SQLException {
                                stmt.setString(1, name );
                        }                       
                }
                
                StationBean stations = fetchStations(SQL, new NameSetter() );
                
                if (stations.entries.size() == 1) {
                        return stations.entries.get(0).getId();
                } else {
                        return -1;
                }
        }
}
1	torben	1255	package dk.thoerup.traininfoservice.db;
2	torben	588
3	torben	1082	import java.sql.Array;
4	torben	588	import java.sql.Connection;
5			import java.sql.PreparedStatement;
6			import java.sql.ResultSet;
7			import java.sql.SQLException;
8			import java.sql.Statement;
9	torben	895	import java.util.logging.Logger;
10	torben	588
11	torben	1061	import dk.thoerup.android.traininfo.common.StationBean;
12	torben	1409	import dk.thoerup.android.traininfo.common.StationEntry;
13	torben	1060
14	torben	588	public class StationDAO {
15	torben	1145
16	torben	1504	private interface StatementParamSetter {
17			public void setParams(PreparedStatement stmt) throws SQLException ;
18			}
19			private class NullSetter implements StatementParamSetter {
20			@Override
21			public void setParams(PreparedStatement stmt) throws SQLException {}
22			}
23
24	torben	1145	public static class NostationException extends Exception {
25			private static final long serialVersionUID = 1L;
26			}
27
28	torben	997	final static int LOCATION_LIMIT = 8;
29	torben	895	static final Logger logger = Logger.getLogger(StationDAO.class.getName());
30	torben	841
31	torben	895
32	torben	1060	private StationEntry convertSingleRow(ResultSet res) throws SQLException {
33			StationEntry station = new StationEntry();
34	torben	836
35	torben	588	station.setId( res.getInt(1) );
36			station.setName( res.getString(2) );
37			station.setLatitude( res.getDouble(3) );
38			station.setLongitude( res.getDouble(4) );
39			station.setRegional( res.getString(5) );
40			station.setStrain( res.getString(6) );
41			station.setMetro( res.getString(7) );
42			station.setAddress( res.getString(8) );
43			station.setCalcdist( (int)res.getDouble(9) );
44	torben	1060
45			station.setIsRegional( station.getRegional() != null );
46			station.setIsStrain( station.getStrain() != null );
47			station.setIsMetro( station.getMetro() != null );
48	torben	836
49	torben	588	return station;
50			}
51	torben	836
52	torben	1060	private StationBean convertResultset(ResultSet res) throws SQLException {
53			StationBean stations = new StationBean();
54	torben	588	while (res.next()) {
55	torben	1060	stations.entries.add( convertSingleRow(res) );
56	torben	588	}
57			return stations;
58	torben	836
59	torben	588	}
60	torben	836
61	torben	1504	private StationBean fetchStations(String SQL, StatementParamSetter setter) throws SQLException {
62			StationBean stations;
63	torben	588	Connection conn = null;
64	torben	1504	PreparedStatement stmt = null;
65	torben	589	ResultSet res = null;
66	torben	588	try {
67			conn = DBConnection.getConnection();
68	torben	1504	stmt = conn.prepareStatement(SQL);
69
70			setter.setParams(stmt);
71	torben	836
72	torben	1504	res = stmt.executeQuery();
73			stations = convertResultset(res);
74
75	torben	588	} finally {
76	torben	589	if (res != null)
77			res.close();
78			if (stmt != null)
79			stmt.close();
80	torben	1504	if (conn!= null)
81	torben	588	conn.close();
82			}
83	torben	1504	return stations;
84
85			}
86	torben	836
87	torben	1504	public StationEntry getById(int id) throws SQLException,NostationException {
88			String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog,stationcode_metro,address,0.0 " +
89			"FROM trainstations WHERE id=" + id + " AND enabled=true";
90
91			StationBean stations = fetchStations(SQL, new NullSetter() );
92
93			if (stations.entries.size() > 0 ) {
94			return stations.entries.get(0);
95			} else {
96			throw new NostationException();
97			}
98	torben	588	}
99	torben	1082
100	torben	836
101	torben	1082
102	torben	714	/*
103			* this code requires theses statements are run on database in order to do ILIKE searches against aliases (which is defines as array of varchar(64) )
104			* create function rlike(text,text) returns bool as
105			* 'select $2 ilike $1' language sql strict immutable;
106	torben	836	* create operator ~~~ (procedure = rlike, leftarg = text, rightarg = text, commutator = ~~);
107	torben	714	*/
108	torben	1507	public StationBean getByNameNormal(final String name) throws SQLException {
109	torben	588	String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, 0.0 " +
110			"FROM trainstations " +
111	torben	714	"WHERE (name ILIKE ? OR ? ~~~ ANY(aliases)) AND enabled = true " +
112	torben	588	"ORDER BY name ";
113
114	torben	1504	class NameSetter implements StatementParamSetter {
115			@Override
116			public void setParams(PreparedStatement stmt) throws SQLException {
117			stmt.setString(1, name + "%");
118			stmt.setString(2, name + "%");
119			}
120	torben	588	}
121	torben	1504
122			return fetchStations(SQL, new NameSetter() );
123	torben	588	}
124	torben	1507
125
126			public StationBean getByNameFuzzy(final String name) throws SQLException {
127			String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, 0.0, " +
128			"levenshtein(lower(name),lower(?) ) as leven " +
129			"FROM trainstations " +
130	torben	1510	"WHERE (levenshtein(lower(name),lower(?) ) <= 3) " +
131	torben	1507	"AND enabled = true " +
132			"ORDER BY leven " +
133			"LIMIT 1";
134	torben	836
135	torben	1507	class NameSetter implements StatementParamSetter {
136			@Override
137			public void setParams(PreparedStatement stmt) throws SQLException {
138			stmt.setString(1, name );
139			stmt.setString(2, name );
140			}
141			}
142
143			StationBean stations = fetchStations(SQL, new NameSetter() );
144			stations.fuzzystrmatch = true;
145			return stations;
146			}
147
148			public StationBean getByName(final String name) throws SQLException {
149			StationBean stations = getByNameNormal(name);
150
151			if (stations.entries.size() == 0) {
152			logger.info("getByName failover: " + name);
153			stations = getByNameFuzzy(name);
154			}
155			return stations;
156			}
157
158
159
160	torben	1254	//Latitude (horizonal), longitude(vertical) so
161			// 1 degree latitude is ~ 111320 meters, since the distance between the horizonal lines is always the same
162			// 1 degree longitude is ~111320 meters at equator but gets shorter as we get closer to the poles.
163			// the "hack" with max 0.4 degrees latitude and 0.75 degrees longitude is only valid since we only service danish trains,
164	torben	928	// in denmark 0.4dg latitude ~ 44km, 0.75dg longitude ~ 47km
165	torben	836
166	torben	741	// the ultra fast method (and only slightly inaccurate as long as we only cover a limited geographically area)
167			// is using an aproximation of the length of 1 latitude degree and 1 longitude degree and just use pythagoras to
168			// calculate the distance:
169	torben	836	// sqrt( power(abs(latitude-?)111320, 2) + power(abs(longitude-?)63000,2) )::int as calcdist
170
171	torben	1504	public StationBean getByLocationWorker(final double latitude, final double longitude, final boolean geolimit) throws SQLException {
172	torben	841
173	torben	929	String limitExpression = (geolimit == true) ? "AND abs(latitude-?)<0.4 AND abs(longitude-?)<0.75 " : "";
174	torben	841
175			String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, " +
176			"earth_distance( earth_coord, ll_to_earth(?,?))::int AS calcdist " +
177			"FROM trainstations " +
178			"WHERE enabled = true " + limitExpression +
179			"ORDER BY calcdist ASC " +
180			"LIMIT " + LOCATION_LIMIT;
181	torben	849
182	torben	841
183	torben	1504	class LatlongSetter implements StatementParamSetter {
184			@Override
185			public void setParams(PreparedStatement stmt) throws SQLException {
186			stmt.setDouble(1, latitude);
187			stmt.setDouble(2, longitude);
188			if (geolimit == true) {
189			stmt.setDouble(3, latitude);
190			stmt.setDouble(4, longitude);
191			}
192			}
193			}
194	torben	849
195	torben	1504	return fetchStations(SQL, new LatlongSetter() );
196	torben	588	}
197	torben	841
198	torben	1060	public StationBean getByLocation(double latitude, double longitude) throws SQLException {
199			StationBean result = getByLocationWorker(latitude, longitude, true);
200	torben	841
201	torben	1060	if (result.entries.size() < LOCATION_LIMIT) { //failover
202	torben	894	logger.info("getByLocation failover: " +latitude + "," + longitude);
203
204	torben	841	result = getByLocationWorker(latitude, longitude, false);
205			}
206
207			return result;
208			}
209
210
211	torben	836
212	torben	1060	public StationBean getByList(String list) throws SQLException {
213	torben	836	String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog,stationcode_metro, address,0.0 " +
214			"FROM trainstations " +
215			"WHERE id IN " + list + " AND enabled = true " +
216			"ORDER BY name ";
217	torben	1504
218			return fetchStations(SQL, new NullSetter() );
219			}
220
221	torben	836
222	torben	1504
223			public StationEntry getSimpleByName(final String name) throws SQLException {
224			String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, 0.0 " +
225			"FROM trainstations " +
226			"WHERE name = ? AND enabled = true " +
227			"LIMIT 1 ";
228	torben	836
229	torben	1504	class NameSetter implements StatementParamSetter {
230			@Override
231			public void setParams(PreparedStatement stmt) throws SQLException {
232			stmt.setString(1, name );
233			}
234	torben	836	}
235	torben	1504
236			StationBean stations = fetchStations(SQL, new NameSetter() );
237
238			if (stations.entries.size() == 1) {
239			return stations.entries.get(0);
240			} else {
241			return null;
242			}
243			}
244	torben	1505
245			//used to create full dump in order to populate Google Appengine DB
246			@Deprecated
247			public StationBean dumpAll() throws SQLException {
248
249			String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog,stationcode_metro,address,0.0,aliases " +
250			"FROM trainstations WHERE enabled = true ORDER BY id";
251
252			Connection conn = null;
253			Statement stmt = null;
254			ResultSet res = null;
255	torben	836
256	torben	1505
257			try {
258			conn = DBConnection.getConnection();
259
260			stmt = conn.createStatement();
261			res = stmt.executeQuery(SQL);
262
263			// Does mostly the same as convertResultset()
264			StationBean stations = new StationBean();
265			while (res.next()) {
266			StationEntry entry = convertSingleRow(res);
267
268			Array arr = res.getArray(10);
269			if (arr != null) {
270			String[] aliases = (String[]) arr.getArray();
271			entry.setAliases(aliases);
272			}
273
274			stations.entries.add( entry );
275
276			}
277			return stations;
278
279
280			} finally {
281			if (res != null)
282			res.close();
283			if (stmt != null)
284			stmt.close();
285			if (conn != null)
286			conn.close();
287			}
288
289			}
290
291	torben	1417	@Deprecated
292	torben	836	public static String getStationName(int stationID) {
293			String station = "";
294
295			Connection conn = null;
296			try {
297			conn = DBConnection.getConnection();
298			Statement stmt = conn.createStatement();
299			ResultSet rs = stmt.executeQuery("SELECT name FROM trainstations WHERE id=" + stationID);
300			if (rs.next()) {
301			station = rs.getString(1);
302			}
303
304			} catch (Exception e) {
305			} finally {
306	torben	588	try {
307	torben	836	if (conn != null && !conn.isClosed())
308	torben	588	conn.close();
309	torben	836	} catch (Exception e) {}
310			}
311	torben	650
312	torben	836	return station;
313			}
314	torben	1417
315	torben	1504
316
317	torben	1417	@Deprecated
318	torben	1504	public int getIdByName(final String name) throws SQLException {
319	torben	836	String SQL = "SELECT id,name,latitude,longitude,stationcode_fjrn,stationcode_stog, stationcode_metro, address, 0.0 " +
320			"FROM trainstations " +
321			"WHERE name = ? AND enabled = true " +
322			"LIMIT 1 ";
323	torben	650
324	torben	1504	class NameSetter implements StatementParamSetter {
325			@Override
326			public void setParams(PreparedStatement stmt) throws SQLException {
327			stmt.setString(1, name );
328			}
329	torben	836	}
330	torben	1504
331			StationBean stations = fetchStations(SQL, new NameSetter() );
332
333			if (stations.entries.size() == 1) {
334			return stations.entries.get(0).getId();
335	torben	836	} else {
336			return -1;
337			}
338			}
339	torben	588	}