/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* Portions Copyright Apache Software Foundation.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.servlet.jsp.jstl.sql;
import java.io.Serializable;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.SortedMap;
import java.util.TreeMap;
/**
* <p>This class creates a cached version of a <tt>ResultSet</tt>.
* It's represented as a <tt>Result</tt> implementation, capable of
* returing an array of <tt>Row</tt> objects containing a <tt>Column</tt>
* instance for each column in the row. It is not part of the JSTL
* API; it serves merely as a back-end to ResultSupport's static methods.
* Thus, we scope its access to the package.
*
* @author Hans Bergsten
* @author Justyna Horwat
*/
class ResultImpl implements Result, Serializable {
private List rowMap;
private List rowByIndex;
private String[] columnNames;
private boolean isLimited;
/**
* This constructor reads the ResultSet and saves a cached
* copy.
* It's important to note that this object will be serializable only
* if the objects returned by the ResultSet are serializable too.
*
* @param rs an open <tt>ResultSet</tt>, positioned before the first
* row
* @param startRow beginning row to be cached
* @param maxRows query maximum rows limit
* @exception java.sql.SQLException if a database error occurs
*/
public ResultImpl(ResultSet rs, int startRow, int maxRows)
throws SQLException
{
rowMap = new ArrayList();
rowByIndex = new ArrayList();
ResultSetMetaData rsmd = rs.getMetaData();
int noOfColumns = rsmd.getColumnCount();
// Create the column name array
columnNames = new String[noOfColumns];
for (int i = 1; i <= noOfColumns; i++) {
columnNames[i-1] = rsmd.getColumnName(i);
}
// Throw away all rows upto startRow
for (int i = 0; i < startRow; i++) {
rs.next();
}
// Process the remaining rows upto maxRows
int processedRows = 0;
while (rs.next()) {
if ((maxRows != -1) && (processedRows == maxRows)) {
isLimited = true;
break;
}
Object[] columns = new Object[noOfColumns];
SortedMap columnMap =
new TreeMap(String.CASE_INSENSITIVE_ORDER);
// JDBC uses 1 as the lowest index!
for (int i = 1; i <= noOfColumns; i++) {
Object value = rs.getObject(i);
if (rs.wasNull()) {
value = null;
}
columns[i-1] = value;
columnMap.put(columnNames[i-1], value);
}
rowMap.add(columnMap);
rowByIndex.add(columns);
processedRows++;
}
}
/**
* Returns an array of SortedMap objects. The SortedMap
* object key is the ColumnName and the value is the ColumnValue.
* SortedMap was created using the CASE_INSENSITIVE_ORDER
* Comparator so the key is the case insensitive representation
* of the ColumnName.
*
* @return an array of Map, or null if there are no rows
*/
public SortedMap[] getRows() {
if (rowMap == null) {
return null;
}
//should just be able to return SortedMap[] object
return (SortedMap []) rowMap.toArray(new SortedMap[0]);
}
/**
* Returns an array of Object[] objects. The first index
* designates the Row, the second the Column. The array
* stores the value at the specified row and column.
*
* @return an array of Object[], or null if there are no rows
*/
public Object[][] getRowsByIndex() {
if (rowByIndex == null) {
return null;
}
//should just be able to return Object[][] object
return (Object [][])rowByIndex.toArray(new Object[0][0]);
}
/**
* Returns an array of String objects. The array represents
* the names of the columns arranged in the same order as in
* the getRowsByIndex() method.
*
* @return an array of String[]
*/
public String[] getColumnNames() {
return columnNames;
}
/**
* Returns the number of rows in the cached ResultSet
*
* @return the number of cached rows, or -1 if the Result could
* not be initialized due to SQLExceptions
*/
public int getRowCount() {
if (rowMap == null) {
return -1;
}
return rowMap.size();
}
/**
* Returns true if the query was limited by a maximum row setting
*
* @return true if the query was limited by a MaxRows attribute
*/
public boolean isLimitedByMaxRows() {
return isLimited;
}
}