001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * Portions Copyright Apache Software Foundation.
007: *
008: * The contents of this file are subject to the terms of either the GNU
009: * General Public License Version 2 only ("GPL") or the Common Development
010: * and Distribution License("CDDL") (collectively, the "License"). You
011: * may not use this file except in compliance with the License. You can obtain
012: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
013: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
014: * language governing permissions and limitations under the License.
015: *
016: * When distributing the software, include this License Header Notice in each
017: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
018: * Sun designates this particular file as subject to the "Classpath" exception
019: * as provided by Sun in the GPL Version 2 section of the License file that
020: * accompanied this code. If applicable, add the following below the License
021: * Header, with the fields enclosed by brackets [] replaced by your own
022: * identifying information: "Portions Copyrighted [year]
023: * [name of copyright owner]"
024: *
025: * Contributor(s):
026: *
027: * If you wish your version of this file to be governed by only the CDDL or
028: * only the GPL Version 2, indicate your decision by adding "[Contributor]
029: * elects to include this software in this distribution under the [CDDL or GPL
030: * Version 2] license." If you don't indicate a single choice of license, a
031: * recipient has the option to distribute your version of this file under
032: * either the CDDL, the GPL Version 2 or to extend the choice of license to
033: * its licensees as provided above. However, if you add GPL Version 2 code
034: * and therefore, elected the GPL Version 2 license, then the option applies
035: * only if the new code is made subject to such option by the copyright
036: * holder.
037: */
038:
039: package javax.servlet.jsp.jstl.sql;
040:
041: import java.util.SortedMap;
042:
043: /**
044: * <p>This interface represents the result of a <sql:query>
045: * action. It provides access to the following information in the
046: * query result:</p>
047: *
048: * <ul>
049: * <li> The result rows (<tt>getRows()</tt> and <tt>getRowsByIndex()</tt>)
050: * <li> The column names (<tt>getColumnNames()</tt>)
051: * <li> The number of rows in the result (<tt>getRowCount()</tt>)
052: * <li> An indication whether the rows returned represent the complete result
053: * or just a subset that is limited by a maximum row setting
054: * (<tt>isLimitedByMaxRows()</tt>)
055: * </ul>
056: *
057: * <p>An implementation of the <tt>Result</tt> interface provides a
058: * <i>disconnected</i> view into the result of a query.
059: *
060: * @author Justyna Horwat
061: *
062: */
063: public interface Result {
064:
065: /**
066: * <p>Returns the result of the query as an array of <code>SortedMap</code> objects.
067: * Each item of the array represents a specific row in the query result.</p>
068: *
069: * <p>A row is structured as a <code>SortedMap</code> object where the key is the column name,
070: * and where the value is the value associated with the column identified by
071: * the key. The column value is an Object of the Java type corresponding
072: * to the mapping between column types and Java types defined by the JDBC
073: * specification when the <code>ResultSet.getObject()</code> method is used.</p>
074: *
075: * <p>The <code>SortedMap</code> must use the <code>Comparator</code>
076: * <code>java.util.String.CASE_INSENSITIVE_ORDER</code>.
077: * This makes it possible to access the key as a case insensitive representation
078: * of a column name. This method will therefore work regardless of the case of
079: * the column name returned by the database.</p>
080: *
081: * @return The result rows as an array of <code>SortedMap</code> objects
082: */
083: public SortedMap[] getRows();
084:
085: /**
086: * Returns the result of the query as an array of arrays.
087: * The first array dimension represents a specific row in the query result.
088: * The array elements for each row are Object instances of the Java type
089: * corresponding to the mapping between column types and Java types defined
090: * by the JDBC specification when the <code>ResultSet.getObject()</code> method is used.
091: *
092: * @return the result rows as an array of <code>Object[]</code> objects
093: */
094: public Object[][] getRowsByIndex();
095:
096: /**
097: * Returns the names of the columns in the result. The order of the names in the array
098: * matches the order in which columns are returned in method getRowsByIndex().
099: *
100: * @return the column names as an array of <code>String</code> objects
101: */
102: public String[] getColumnNames();
103:
104: /**
105: * Returns the number of rows in the cached ResultSet
106: *
107: * @return the number of rows in the result
108: */
109: public int getRowCount();
110:
111: /**
112: * Returns true if the query was limited by a maximum row setting
113: *
114: * @return <tt>true</tt> if the query was limited by a maximum
115: * row setting
116: */
117: public boolean isLimitedByMaxRows();
118: }
|