Remove all javadoc author tags.
[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
28 import org.glom.libglom.Document;
29 import org.glom.libglom.Field;
30 import org.glom.libglom.LayoutFieldVector;
31 import org.glom.libglom.LayoutItem_Field;
32 import org.glom.libglom.SortClause;
33 import org.glom.libglom.SortFieldPair;
34 import org.glom.web.server.Log;
35 import org.glom.web.server.Utils;
36 import org.glom.web.shared.DataItem;
37
38 import com.mchange.v2.c3p0.ComboPooledDataSource;
39
40 /**
41  *
42  */
43 public abstract class ListDBAccess extends DBAccess {
44         protected LayoutFieldVector fieldsToGet;
45
46         protected ListDBAccess(Document document, String documentID, ComboPooledDataSource cpds, String tableName) {
47                 super(document, documentID, cpds, tableName);
48         }
49
50         protected abstract String getSelectQuery(SortClause sortClause);
51
52         protected abstract String getCountQuery();
53
54         protected ArrayList<DataItem[]> getListData(int start, int length, boolean useSortClause, int sortColumnIndex,
55                         boolean isAscending) {
56
57                 // create a sort clause for the column we've been asked to sort
58                 SortClause sortClause = new SortClause();
59                 if (useSortClause) {
60                         org.glom.libglom.LayoutItem item = fieldsToGet.get(sortColumnIndex);
61                         LayoutItem_Field layoutItemField = LayoutItem_Field.cast_dynamic(item);
62                         if (layoutItemField != null)
63                                 sortClause.addLast(new SortFieldPair(layoutItemField, isAscending));
64                         else {
65                                 Log.error(documentID, tableName, "Error getting LayoutItem_Field for column index " + sortColumnIndex
66                                                 + ". Cannot create a sort clause for this column.");
67                         }
68                 } else {
69                         // create a sort clause for the primary key if we're not asked to sort a specific column
70                         int numItems = Utils.safeLongToInt(fieldsToGet.size());
71                         for (int i = 0; i < numItems; i++) {
72                                 LayoutItem_Field layoutItem = fieldsToGet.get(i);
73                                 Field details = layoutItem.get_full_field_details();
74                                 if (details != null && details.get_primary_key()) {
75                                         sortClause.addLast(new SortFieldPair(layoutItem, true)); // ascending
76                                         break;
77                                 }
78                         }
79                 }
80
81                 ArrayList<DataItem[]> rowsList = new ArrayList<DataItem[]>();
82                 Connection conn = null;
83                 Statement st = null;
84                 ResultSet rs = null;
85                 try {
86                         // Setup the JDBC driver and get the query. Special care needs to be take to ensure that the results will be
87                         // based on a cursor so that large amounts of memory are not consumed when the query retrieve a large amount
88                         // of data. Here's the relevant PostgreSQL documentation:
89                         // http://jdbc.postgresql.org/documentation/83/query.html#query-with-cursor
90                         conn = cpds.getConnection();
91                         conn.setAutoCommit(false);
92                         st = conn.createStatement(ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY);
93                         st.setFetchSize(length);
94                         String query = getSelectQuery(sortClause) + " OFFSET " + start;
95                         // TODO Test memory usage before and after we execute the query that would result in a large ResultSet.
96                         // We need to ensure that the JDBC driver is in fact returning a cursor based result set that has a low
97                         // memory footprint. Check the difference between this value before and after the query:
98                         // Runtime.getRuntime().totalMemory() - Runtime.getRuntime().freeMemory()
99                         // Test the execution time at the same time (see the todo item in getLayoutListTable()).
100                         rs = st.executeQuery(query);
101
102                         // get the results from the ResultSet
103                         rowsList = convertResultSetToDTO(length, fieldsToGet, rs);
104                 } catch (SQLException e) {
105                         Log.error(documentID, tableName, "Error executing database query.", e);
106                         // TODO: somehow notify user of problem
107                 } finally {
108                         // cleanup everything that has been used
109                         try {
110                                 if (rs != null)
111                                         rs.close();
112                                 if (st != null)
113                                         st.close();
114                                 if (conn != null)
115                                         conn.close();
116                         } catch (Exception e) {
117                                 Log.error(documentID, tableName,
118                                                 "Error closing database resources. Subsequent database queries may not work.", e);
119                         }
120                 }
121                 return rowsList;
122         }
123
124         /*
125          * Get the number of rows a query with the table name and layout fields would return. This is needed for the /* list
126          * view pager.
127          */
128         protected int getResultSizeOfSQLQuery() {
129
130                 Connection conn = null;
131                 Statement st = null;
132                 ResultSet rs = null;
133                 try {
134                         // Setup and execute the count query. Special care needs to be take to ensure that the results will be based
135                         // on a cursor so that large amounts of memory are not consumed when the query retrieve a large amount of
136                         // data. Here's the relevant PostgreSQL documentation:
137                         // http://jdbc.postgresql.org/documentation/83/query.html#query-with-cursor
138                         conn = cpds.getConnection();
139                         conn.setAutoCommit(false);
140                         st = conn.createStatement(ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY);
141                         String query = getCountQuery();
142                         // TODO Test execution time of this query with when the number of rows in the table is large (say >
143                         // 1,000,000). Test memory usage at the same time (see the todo item in getTableData()).
144                         rs = st.executeQuery(query);
145
146                         // get the number of rows in the query
147                         rs.next();
148                         return rs.getInt(1);
149
150                 } catch (SQLException e) {
151                         Log.error(documentID, tableName, "Error calculating number of rows in the query.", e);
152                         return -1;
153                 } finally {
154                         // cleanup everything that has been used
155                         try {
156                                 if (rs != null)
157                                         rs.close();
158                                 if (st != null)
159                                         st.close();
160                                 if (conn != null)
161                                         conn.close();
162                         } catch (Exception e) {
163                                 Log.error(documentID, tableName,
164                                                 "Error closing database resources. Subsequent database queries may not work.", e);
165                         }
166                 }
167         }
168
169 }