jakarta.servlet.jsp.jstl.sql.Result Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package jakarta.servlet.jsp.jstl.sql;
import java.util.SortedMap;
/**
*
* This interface represents the result of a <sql:query> action. It provides access to the following information
* in the query result:
*
*
*
* - The result rows (getRows() and getRowsByIndex())
*
- The column names (getColumnNames())
*
- The number of rows in the result (getRowCount())
*
- An indication whether the rows returned represent the complete result or just a subset that is limited by a
* maximum row setting (isLimitedByMaxRows())
*
*
*
* An implementation of the Result interface provides a disconnected view into the result of a query.
*
* @author Justyna Horwat
*
*/
public interface Result {
/**
*
* Returns the result of the query as an array of SortedMap objects. Each item of the array represents a
* specific row in the query result.
*
*
*
* A row is structured as a SortedMap object where the key is the column name, and where the value is the
* value associated with the column identified by the key. The column value is an Object of the Java type corresponding
* to the mapping between column types and Java types defined by the JDBC specification when the
* ResultSet.getObject() method is used.
*
*
*
* The SortedMap must use the Comparator java.util.String.CASE_INSENSITIVE_ORDER.
* This makes it possible to access the key as a case insensitive representation of a column name. This method will
* therefore work regardless of the case of the column name returned by the database.
*
*
* @return The result rows as an array of SortedMap objects
*/
SortedMap[] getRows();
/**
* Returns the result of the query as an array of arrays. The first array dimension represents a specific row in the
* query result. The array elements for each row are Object instances of the Java type corresponding to the mapping
* between column types and Java types defined by the JDBC specification when the ResultSet.getObject()
* method is used.
*
* @return the result rows as an array of Object[] objects
*/
Object[][] getRowsByIndex();
/**
* Returns the names of the columns in the result. The order of the names in the array matches the order in which
* columns are returned in method getRowsByIndex().
*
* @return the column names as an array of String objects
*/
String[] getColumnNames();
/**
* Returns the number of rows in the cached ResultSet
*
* @return the number of rows in the result
*/
int getRowCount();
/**
* Returns true if the query was limited by a maximum row setting
*
* @return true if the query was limited by a maximum row setting
*/
boolean isLimitedByMaxRows();
}