1 /*
2 * The Apache Software License, Version 1.1
3 *
4 * Copyright (c) 1999 The Apache Software Foundation. All rights
5 * reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 *
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 *
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
17 * distribution.
18 *
19 * 3. The end-user documentation included with the redistribution, if
20 * any, must include the following acknowlegement:
21 * "This product includes software developed by the
22 * Apache Software Foundation (http://www.apache.org/)."
23 * Alternately, this acknowlegement may appear in the software itself,
24 * if and wherever such third-party acknowlegements normally appear.
25 *
26 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
27 * Foundation" must not be used to endorse or promote products derived
28 * from this software without prior written permission. For written
29 * permission, please contact apache@apache.org.
30 *
31 * 5. Products derived from this software may not be called "Apache"
32 * nor may "Apache" appear in their names without prior written
33 * permission of the Apache Group.
34 *
35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46 * SUCH DAMAGE.
47 * ====================================================================
48 *
49 * This software consists of voluntary contributions made by many
50 * individuals on behalf of the Apache Software Foundation. For more
51 * information on the Apache Software Foundation, please see
52 * <http://www.apache.org/>.
53 *
54 */
55
56 package javax.servlet.jsp.jstl.sql;
57
58 import java.util.SortedMap;
59
60 /***
61 * <p>This interface represents the result of a <sql:query>
62 * action. It provides access to the following information in the
63 * query result:</p>
64 *
65 * <ul>
66 * <li> result rows
67 * <li> result rows using an index
68 * <li> number of rows in the result
69 * <li> result meta data
70 * <li> indication whether result returned is a complete set or
71 * a subset limited by a maximum row setting
72 * </ul>
73 *
74 * @author Justyna Horwat
75 *
76 */
77 public interface Result {
78
79 /***
80 * Returns an array of SortedMap objects. Column name is used as the key
81 * for the column value. SortedMap must use the CASE_INSENSITIVE_ORDER
82 * Comparator so that the key is the case insensitive representation
83 * of the column name.
84 *
85 * @return the result rows as an array of <code>SortedMap</code> objects
86 */
87 public SortedMap[] getRows();
88
89 /***
90 * Returns an array of Objects[]. The first index
91 * designates the Row, the second the Column. The array
92 * stores the value at the specified row and column.
93 *
94 * @return the result rows as an array of <code>Object[]</code> objects
95 */
96 public Object[][] getRowsByIndex();
97
98 /***
99 * Returns an array of column names.
100 *
101 * @return the column names as an array of <code>String</code> objects
102 */
103 public String[] getColumnNames();
104
105 /***
106 * Returns the number of rows in the cached ResultSet
107 *
108 * @return the number of rows in the result
109 */
110 public int getRowCount();
111
112 /***
113 * Returns true of the query was limited by a maximum row setting
114 *
115 * @return <tt>true</tt> if the query was limited by a maximum
116 * row setting
117 */
118 public boolean isLimitedByMaxRows();
119 }
This page was automatically generated by Maven