Some code reformatting by Eclipse
[online-glom:gwt-glom.git] / src / main / java / org / glom / web / server / database / ListDBAccess.java
1 /*
2  * Copyright (C) 2011 Openismus GmbH
3  *
4  * This file is part of GWT-Glom.
5  *
6  * GWT-Glom is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as published by the
8  * Free Software Foundation, either version 3 of the License, or (at your
9  * option) any later version.
10  *
11  * GWT-Glom is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
14  * for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with GWT-Glom.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 package org.glom.web.server.database;
21
22 import java.sql.Connection;
23 import java.sql.ResultSet;
24 import java.sql.SQLException;
25 import java.sql.Statement;
26 import java.util.ArrayList;
27 import java.util.List;
28
29 import org.glom.web.server.Log;
30 import org.glom.web.server.Utils;
31 import org.glom.web.shared.DataItem;
32 import org.glom.web.shared.libglom.Document;
33 import org.glom.web.shared.libglom.Field;
34 import org.glom.web.shared.libglom.layout.LayoutItem;
35 import org.glom.web.shared.libglom.layout.LayoutItemField;
36 import org.glom.web.shared.libglom.layout.SortClause;
37 import org.glom.web.shared.libglom.layout.UsesRelationship;
38
39 import com.mchange.v2.c3p0.ComboPooledDataSource;
40
41 /**
42  *
43  */
44 public abstract class ListDBAccess extends DBAccess {
45         protected List<LayoutItemField> fieldsToGet;
46
47         protected ListDBAccess(final Document document, final String documentID, final ComboPooledDataSource cpds,
48                         final String tableName) {
49                 super(document, documentID, cpds, tableName);
50         }
51
52         protected abstract String getSelectQuery(Connection connection, String quickFind, SortClause sortClause);
53
54         protected abstract String getCountQuery(Connection connection);
55
56         protected ArrayList<DataItem[]> getListData(final String quickFind, final int start, final int length,
57                         final boolean useSortClause, final int sortColumnIndex, final boolean isAscending) {
58
59                 // create a sort clause for the column we've been asked to sort
60                 final SortClause sortClause = new SortClause();
61                 if (useSortClause) {
62                         final LayoutItem item = fieldsToGet.get(sortColumnIndex);
63                         if (item instanceof LayoutItemField) {
64                                 final UsesRelationship layoutItemField = (UsesRelationship) item;
65                                 sortClause.add(new SortClause.SortField(layoutItemField, isAscending));
66                         } else {
67                                 Log.error(documentID, tableName, "Error getting LayoutItemField for column index " + sortColumnIndex
68                                                 + ". Cannot create a sort clause for this column.");
69                         }
70                 } else {
71                         // create a sort clause for the primary key if we're not asked to sort a specific column
72                         final int numItems = Utils.safeLongToInt(fieldsToGet.size());
73                         for (int i = 0; i < numItems; i++) {
74                                 final LayoutItemField layoutItem = fieldsToGet.get(i);
75                                 final Field details = layoutItem.get_full_field_details();
76                                 if (details != null && details.get_primary_key()) {
77                                         sortClause.add(new SortClause.SortField(layoutItem, true)); // ascending
78                                         break;
79                                 }
80                         }
81                 }
82
83                 ArrayList<DataItem[]> rowsList = new ArrayList<DataItem[]>();
84                 Connection conn = null;
85                 Statement st = null;
86                 ResultSet rs = null;
87                 try {
88                         // Setup the JDBC driver and get the query. Special care needs to be take to ensure that the results will be
89                         // based on a cursor so that large amounts of memory are not consumed when the query retrieve a large amount
90                         // of data. Here's the relevant PostgreSQL documentation:
91                         // http://jdbc.postgresql.org/documentation/83/query.html#query-with-cursor
92                         conn = cpds.getConnection();
93                         conn.setAutoCommit(false);
94                         st = conn.createStatement(ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY);
95                         st.setFetchSize(length);
96                         final String query = getSelectQuery(conn, quickFind, sortClause) + " OFFSET " + start;
97                         // TODO Test memory usage before and after we execute the query that would result in a large ResultSet.
98                         // We need to ensure that the JDBC driver is in fact returning a cursor based result set that has a low
99                         // memory footprint. Check the difference between this value before and after the query:
100                         // Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory()
101                         // Test the execution time at the same time (see the todo item in getLayoutListTable()).
102                         rs = st.executeQuery(query);
103
104                         // get the results from the ResultSet
105                         rowsList = convertResultSetToDTO(length, fieldsToGet, rs);
106                 } catch (final SQLException e) {
107                         Log.error(documentID, tableName, "Error executing database query.", e);
108                         // TODO: somehow notify user of problem
109                 } finally {
110                         // cleanup everything that has been used
111                         try {
112                                 if (rs != null)
113                                         rs.close();
114                                 if (st != null)
115                                         st.close();
116                                 if (conn != null)
117                                         conn.close();
118                         } catch (final Exception e) {
119                                 Log.error(documentID, tableName,
120                                                 "Error closing database resources. Subsequent database queries may not work.", e);
121                         }
122                 }
123                 return rowsList;
124         }
125
126         /*
127          * Get the number of rows a query with the table name and layout fields would return. This is needed for the /* list
128          * view pager.
129          */
130         protected int getResultSizeOfSQLQuery() {
131
132                 Connection conn = null;
133                 Statement st = null;
134                 ResultSet rs = null;
135                 try {
136                         // Setup and execute the count query. Special care needs to be take to ensure that the results will be based
137                         // on a cursor so that large amounts of memory are not consumed when the query retrieve a large amount of
138                         // data. Here's the relevant PostgreSQL documentation:
139                         // http://jdbc.postgresql.org/documentation/83/query.html#query-with-cursor
140                         conn = cpds.getConnection();
141                         conn.setAutoCommit(false);
142                         st = conn.createStatement(ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY);
143                         final String query = getCountQuery(conn);
144                         // TODO Test execution time of this query with when the number of rows in the table is large (say >
145                         // 1,000,000). Test memory usage at the same time (see the todo item in getTableData()).
146                         rs = st.executeQuery(query);
147
148                         // get the number of rows in the query
149                         rs.next();
150                         return rs.getInt(1);
151
152                 } catch (final SQLException e) {
153                         Log.error(documentID, tableName, "Error calculating number of rows in the query.", e);
154                         return -1;
155                 } finally {
156                         // cleanup everything that has been used
157                         try {
158                                 if (rs != null)
159                                         rs.close();
160                                 if (st != null)
161                                         st.close();
162                                 if (conn != null)
163                                         conn.close();
164                         } catch (final Exception e) {
165                                 Log.error(documentID, tableName,
166                                                 "Error closing database resources. Subsequent database queries may not work.", e);
167                         }
168                 }
169         }
170
171 }