OnlineGlomService: Simplify the getList/RelatedViewData() methods.
[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.server.libglom.Document;
32 import org.glom.web.shared.DataItem;
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(String quickFind, SortClause sortClause);
53
54         protected abstract String getCountQuery();
55
56         /**
57          * 
58          * @param quickFind
59          * @param start
60          * @param length
61          * @param sortColumnIndex
62          *            The index of the column to sort by, or -1 for none.
63          * @param isAscending
64          * @return
65          */
66         protected ArrayList<DataItem[]> getListData(final String quickFind, final int start, final int length,
67                         final int sortColumnIndex, final boolean isAscending) {
68
69                 // create a sort clause for the column we've been asked to sort
70                 final SortClause sortClause = new SortClause();
71                 if (sortColumnIndex != -1) {
72                         final LayoutItem item = fieldsToGet.get(sortColumnIndex);
73                         if (item instanceof LayoutItemField) {
74                                 final UsesRelationship layoutItemField = (UsesRelationship) item;
75                                 sortClause.add(new SortClause.SortField(layoutItemField, isAscending));
76                         } else {
77                                 Log.error(documentID, tableName, "Error getting LayoutItemField for column index " + sortColumnIndex
78                                                 + ". Cannot create a sort clause for this column.");
79                         }
80                 } else {
81                         // create a sort clause for the primary key if we're not asked to sort a specific column
82                         int numItems = 0;
83                         if (fieldsToGet != null) {
84                                 numItems = Utils.safeLongToInt(fieldsToGet.size());
85                         }
86
87                         for (int i = 0; i < numItems; i++) {
88                                 final LayoutItemField layoutItem = fieldsToGet.get(i);
89                                 final Field details = layoutItem.getFullFieldDetails();
90                                 if (details != null && details.getPrimaryKey()) {
91                                         sortClause.add(new SortClause.SortField(layoutItem, true)); // ascending
92                                         break;
93                                 }
94                         }
95                 }
96
97                 ArrayList<DataItem[]> rowsList = new ArrayList<DataItem[]>();
98                 Connection conn = null;
99                 Statement st = null;
100                 ResultSet rs = null;
101                 try {
102                         // Setup the JDBC driver and get the query. Special care needs to be take to ensure that the results will be
103                         // based on a cursor so that large amounts of memory are not consumed when the query retrieve a large amount
104                         // of data. Here's the relevant PostgreSQL documentation:
105                         // http://jdbc.postgresql.org/documentation/83/query.html#query-with-cursor
106                         conn = cpds.getConnection();
107                         conn.setAutoCommit(false);
108                         st = conn.createStatement(ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY);
109                         st.setFetchSize(length);
110                         final String query = getSelectQuery(quickFind, sortClause) + " OFFSET " + start;
111                         // TODO Test memory usage before and after we execute the query that would result in a large ResultSet.
112                         // We need to ensure that the JDBC driver is in fact returning a cursor based result set that has a low
113                         // memory footprint. Check the difference between this value before and after the query:
114                         // Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory()
115                         // Test the execution time at the same time (see the todo item in getLayoutListTable()).
116                         rs = st.executeQuery(query);
117
118                         // get the results from the ResultSet
119                         rowsList = convertResultSetToDTO(length, fieldsToGet, rs);
120                 } catch (final SQLException e) {
121                         Log.error(documentID, tableName, "Error executing database query.", e);
122                         // TODO: somehow notify user of problem
123                 } finally {
124                         // cleanup everything that has been used
125                         try {
126                                 if (rs != null) {
127                                         rs.close();
128                                 }
129                                 if (st != null) {
130                                         st.close();
131                                 }
132                                 if (conn != null) {
133                                         conn.close();
134                                 }
135                         } catch (final Exception e) {
136                                 Log.error(documentID, tableName,
137                                                 "Error closing database resources. Subsequent database queries may not work.", e);
138                         }
139                 }
140                 return rowsList;
141         }
142
143         /*
144          * Get the number of rows a query with the table name and layout fields would return. This is needed for the /* list
145          * view pager.
146          */
147         protected int getResultSizeOfSQLQuery() {
148
149                 Connection conn = null;
150                 Statement st = null;
151                 ResultSet rs = null;
152                 try {
153                         // Setup and execute the count query. Special care needs to be take to ensure that the results will be based
154                         // on a cursor so that large amounts of memory are not consumed when the query retrieve a large amount of
155                         // data. Here's the relevant PostgreSQL documentation:
156                         // http://jdbc.postgresql.org/documentation/83/query.html#query-with-cursor
157                         conn = cpds.getConnection();
158                         conn.setAutoCommit(false);
159                         st = conn.createStatement(ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY);
160                         final String query = getCountQuery();
161
162                         // TODO Test execution time of this query with when the number of rows in the table is large (say >
163                         // 1,000,000). Test memory usage at the same time (see the todo item in getTableData()).
164                         rs = st.executeQuery(query);
165
166                         // get the number of rows in the query
167                         rs.next();
168                         return rs.getInt(1);
169
170                 } catch (final SQLException e) {
171                         Log.error(documentID, tableName, "Error calculating number of rows in the query.", e);
172                         return -1;
173                 } finally {
174                         // cleanup everything that has been used
175                         try {
176                                 if (rs != null) {
177                                         rs.close();
178                                 }
179                                 if (st != null) {
180                                         st.close();
181                                 }
182                                 if (conn != null) {
183                                         conn.close();
184                                 }
185                         } catch (final Exception e) {
186                                 Log.error(documentID, tableName,
187                                                 "Error closing database resources. Subsequent database queries may not work.", e);
188                         }
189                 }
190         }
191
192 }