mirror of git://gcc.gnu.org/git/gcc.git
1614 lines
57 KiB
Java
1614 lines
57 KiB
Java
/* ResultSet.java -- A SQL statement result set.
|
|
Copyright (C) 1999, 2000, 2002, 2006 Free Software Foundation, Inc.
|
|
|
|
This file is part of GNU Classpath.
|
|
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2, or (at your option)
|
|
any later version.
|
|
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301 USA.
|
|
|
|
Linking this library statically or dynamically with other modules is
|
|
making a combined work based on this library. Thus, the terms and
|
|
conditions of the GNU General Public License cover the whole
|
|
combination.
|
|
|
|
As a special exception, the copyright holders of this library give you
|
|
permission to link this library with independent modules to produce an
|
|
executable, regardless of the license terms of these independent
|
|
modules, and to copy and distribute the resulting executable under
|
|
terms of your choice, provided that you also meet, for each linked
|
|
independent module, the terms and conditions of the license of that
|
|
module. An independent module is a module which is not derived from
|
|
or based on this library. If you modify this library, you may extend
|
|
this exception to your version of the library, but you are not
|
|
obligated to do so. If you do not wish to do so, delete this
|
|
exception statement from your version. */
|
|
|
|
|
|
package java.sql;
|
|
|
|
import java.io.InputStream;
|
|
import java.io.Reader;
|
|
import java.math.BigDecimal;
|
|
import java.net.URL;
|
|
import java.util.Calendar;
|
|
import java.util.Map;
|
|
|
|
/**
|
|
* This interface provides access to the data set returned by a SQL
|
|
* statement. An instance of this interface is returned by the various
|
|
* execution methods in the <code>Statement</code>.
|
|
*
|
|
* <p> This class models a cursor, which can be stepped through one row at a
|
|
* time. Methods are provided for accessing columns by column name or by
|
|
* index.</p>
|
|
*
|
|
* <p> Note that a result set is invalidated if the statement that returned
|
|
* it is closed.</p>
|
|
*
|
|
* @author Aaron M. Renn (arenn@urbanophile.com)
|
|
*/
|
|
public interface ResultSet
|
|
extends AutoCloseable
|
|
{
|
|
/**
|
|
* The rows will be processed in order from first to last.
|
|
*/
|
|
int FETCH_FORWARD = 1000;
|
|
|
|
/**
|
|
* The rows will be processed in order from last to first.
|
|
*/
|
|
int FETCH_REVERSE = 1001;
|
|
|
|
/**
|
|
* The rows will be processed in an unknown order
|
|
*/
|
|
int FETCH_UNKNOWN = 1002;
|
|
|
|
/**
|
|
* This type of result set may only step forward through the rows returned.
|
|
*/
|
|
int TYPE_FORWARD_ONLY = 1003;
|
|
|
|
/**
|
|
* This type of result set is scrollable and is not sensitive to changes
|
|
* made by other statements.
|
|
*/
|
|
int TYPE_SCROLL_INSENSITIVE = 1004;
|
|
|
|
/**
|
|
* This type of result set is scrollable and is also sensitive to changes
|
|
* made by other statements.
|
|
*/
|
|
int TYPE_SCROLL_SENSITIVE = 1005;
|
|
|
|
/**
|
|
* The concurrency mode of for the result set may not be modified.
|
|
*/
|
|
int CONCUR_READ_ONLY = 1007;
|
|
|
|
/**
|
|
* The concurrency mode of for the result set may be modified.
|
|
*/
|
|
int CONCUR_UPDATABLE = 1008;
|
|
|
|
int HOLD_CURSORS_OVER_COMMIT = 1;
|
|
|
|
int CLOSE_CURSORS_AT_COMMIT = 2;
|
|
|
|
/**
|
|
* This method advances to the next row in the result set. Any streams
|
|
* open on the current row are closed automatically.
|
|
*
|
|
* @return <code>true</code> if the next row exists, <code>false</code>
|
|
* otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean next() throws SQLException;
|
|
|
|
/**
|
|
* This method closes the result set and frees any associated resources.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void close() throws SQLException;
|
|
|
|
/**
|
|
* This method tests whether the value of the last column that was fetched
|
|
* was actually a SQL NULL value.
|
|
*
|
|
* @return <code>true</code> if the last column fetched was a NULL,
|
|
* <code>false</code> otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean wasNull() throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>String</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>String</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
String getString(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>boolean</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>boolean</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean getBoolean(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>byte</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>byte</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
byte getByte(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>short</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>short</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
short getShort(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>int</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>int</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
int getInt(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>long</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>long</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
long getLong(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>float</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>float</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
float getFloat(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>double</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>double</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
double getDouble(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>BigDecimal</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @param scale The number of digits to the right of the decimal to return.
|
|
* @return The column value as a <code>BigDecimal</code>.
|
|
* @exception SQLException If an error occurs.
|
|
* @deprecated
|
|
*/
|
|
BigDecimal getBigDecimal(int columnIndex, int scale)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* byte array.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a byte array
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
byte[] getBytes(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>java.sql.Date</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>java.sql.Date</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Date getDate(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>java.sql.Time</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>java.sql.Time</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Time getTime(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>java.sql.Timestamp</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>java.sql.Timestamp</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Timestamp getTimestamp(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as an ASCII
|
|
* stream. Note that all the data from this stream must be read before
|
|
* fetching the value of any other column. Please also be aware that
|
|
* calling <code>next()</code> or <code>close()</code> on this result set
|
|
* will close this stream as well.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as an ASCII <code>InputStream</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
InputStream getAsciiStream(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Unicode UTF-8
|
|
* stream. Note that all the data from this stream must be read before
|
|
* fetching the value of any other column. Please also be aware that
|
|
* calling <code>next()</code> or <code>close()</code> on this result set
|
|
* will close this stream as well.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a Unicode UTF-8 <code>InputStream</code>.
|
|
* @exception SQLException If an error occurs.
|
|
* @deprecated Use getCharacterStream instead.
|
|
*/
|
|
InputStream getUnicodeStream(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a raw byte
|
|
* stream. Note that all the data from this stream must be read before
|
|
* fetching the value of any other column. Please also be aware that
|
|
* calling <code>next()</code> or <code>close()</code> on this result set
|
|
* will close this stream as well.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a raw byte <code>InputStream</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
InputStream getBinaryStream(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>String</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>String</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
String getString(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>boolean</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>boolean</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean getBoolean(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>byte</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>byte</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
byte getByte(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>short</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>short</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
short getShort(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>int</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>int</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
int getInt(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>long</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>long</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
long getLong(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>float</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>float</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
float getFloat(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>double</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>double</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
double getDouble(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>BigDecimal</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>BigDecimal</code>.
|
|
* @exception SQLException If an error occurs.
|
|
* @deprecated
|
|
*/
|
|
BigDecimal getBigDecimal(String columnName, int scale)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* byte array.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a byte array
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
byte[] getBytes(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>java.sql.Date</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>java.sql.Date</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Date getDate(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>java.sql.Time</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>java.sql.Time</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Time getTime(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>java.sql.Timestamp</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>java.sql.Timestamp</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Timestamp getTimestamp(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as an ASCII
|
|
* stream. Note that all the data from this stream must be read before
|
|
* fetching the value of any other column. Please also be aware that
|
|
* calling <code>next()</code> or <code>close()</code> on this result set
|
|
* will close this stream as well.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as an ASCII <code>InputStream</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
InputStream getAsciiStream(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Unicode UTF-8
|
|
* stream. Note that all the data from this stream must be read before
|
|
* fetching the value of any other column. Please also be aware that
|
|
* calling <code>next()</code> or <code>close()</code> on this result set
|
|
* will close this stream as well.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a Unicode UTF-8 <code>InputStream</code>.
|
|
* @exception SQLException If an error occurs.
|
|
* @deprecated Use getCharacterStream instead.
|
|
*/
|
|
InputStream getUnicodeStream(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a raw byte
|
|
* stream. Note that all the data from this stream must be read before
|
|
* fetching the value of any other column. Please also be aware that
|
|
* calling <code>next()</code> or <code>close()</code> on this result set
|
|
* will close this stream as well.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a raw byte <code>InputStream</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
InputStream getBinaryStream(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the first SQL warning associated with this result
|
|
* set. Any additional warnings will be chained to this one.
|
|
*
|
|
* @return The first SQLWarning for this result set, or <code>null</code> if
|
|
* there are no warnings.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
SQLWarning getWarnings() throws SQLException;
|
|
|
|
/**
|
|
* This method clears all warnings associated with this result set.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void clearWarnings() throws SQLException;
|
|
|
|
/**
|
|
* This method returns the name of the database cursor used by this
|
|
* result set.
|
|
*
|
|
* @return The name of the database cursor used by this result set.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
String getCursorName() throws SQLException;
|
|
|
|
/**
|
|
* This method returns data about the columns returned as part of the
|
|
* result set as a <code>ResultSetMetaData</code> instance.
|
|
*
|
|
* @return The <code>ResultSetMetaData</code> instance for this result set.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
ResultSetMetaData getMetaData() throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>Object</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as an <code>Object</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Object getObject(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>Object</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as an <code>Object</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Object getObject(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the column index of the specified named column.
|
|
*
|
|
* @param columnName The name of the column.
|
|
* @return The index of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
int findColumn(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a character
|
|
* stream. Note that all the data from this stream must be read before
|
|
* fetching the value of any other column. Please also be aware that
|
|
* calling <code>next()</code> or <code>close()</code> on this result set
|
|
* will close this stream as well.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as an character <code>Reader</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Reader getCharacterStream(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a character
|
|
* stream. Note that all the data from this stream must be read before
|
|
* fetching the value of any other column. Please also be aware that
|
|
* calling <code>next()</code> or <code>close()</code> on this result set
|
|
* will close this stream as well.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as an character <code>Reader</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Reader getCharacterStream(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>BigDecimal</code>.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return The column value as a <code>BigDecimal</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
BigDecimal getBigDecimal(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>BigDecimal</code>.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return The column value as a <code>BigDecimal</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
BigDecimal getBigDecimal(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method tests whether or not the cursor is before the first row
|
|
* in the result set.
|
|
*
|
|
* @return <code>true</code> if the cursor is positioned before the first
|
|
* row, <code>false</code> otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean isBeforeFirst() throws SQLException;
|
|
|
|
/**
|
|
* This method tests whether or not the cursor is after the last row
|
|
* in the result set.
|
|
*
|
|
* @return <code>true</code> if the cursor is positioned after the last
|
|
* row, <code>false</code> otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean isAfterLast() throws SQLException;
|
|
|
|
/**
|
|
* This method tests whether or not the cursor is positioned on the first
|
|
* row in the result set.
|
|
*
|
|
* @return <code>true</code> if the cursor is positioned on the first
|
|
* row, <code>false</code> otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean isFirst() throws SQLException;
|
|
|
|
/**
|
|
* This method tests whether or not the cursor is on the last row
|
|
* in the result set.
|
|
*
|
|
* @return <code>true</code> if the cursor is positioned on the last
|
|
* row, <code>false</code> otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean isLast() throws SQLException;
|
|
|
|
/**
|
|
* This method repositions the cursor to before the first row in the
|
|
* result set.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void beforeFirst() throws SQLException;
|
|
|
|
/**
|
|
* This method repositions the cursor to after the last row in the result
|
|
* set.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void afterLast() throws SQLException;
|
|
|
|
/**
|
|
* This method repositions the cursor on the first row in the
|
|
* result set.
|
|
*
|
|
* @return <code>true</code> if the cursor is on a valid row;
|
|
* <code>false</code> if there are no rows in the result set.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean first() throws SQLException;
|
|
|
|
/**
|
|
* This method repositions the cursor on the last row in the result
|
|
* set.
|
|
*
|
|
* @return <code>true</code> if the cursor is on a valid row;
|
|
* <code>false</code> if there are no rows in the result set.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean last() throws SQLException;
|
|
|
|
/**
|
|
* This method returns the current row number in the cursor. Numbering
|
|
* begins at index 1.
|
|
*
|
|
* @return The current row number, or 0 if there is not current row.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
int getRow() throws SQLException;
|
|
|
|
/**
|
|
* This method positions the result set to the specified absolute row.
|
|
* Positive numbers are row offsets from the beginning of the result
|
|
* set (numbering starts from row 1) and negative numbers are row offsets
|
|
* from the end of the result set (numbering starts from -1).
|
|
*
|
|
* @param row The row to position the result set to.
|
|
*
|
|
* @return <code>true</code> if the current position was changed,
|
|
* <code>false</code> otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean absolute(int row) throws SQLException;
|
|
|
|
/**
|
|
* This method moves the result set position relative to the current row.
|
|
* The offset can be positive or negative.
|
|
*
|
|
* @param rows The number of row positions to move.
|
|
* @return <code>true</code> if the current position was changed,
|
|
* <code>false</code> otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean relative(int rows) throws SQLException;
|
|
|
|
/**
|
|
* This method moves the current position to the previous row in the
|
|
* result set.
|
|
*
|
|
* @return <code>true</code> if the previous row exists, <code>false</code>
|
|
* otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean previous() throws SQLException;
|
|
|
|
/**
|
|
* This method provides a hint to the driver about which direction the
|
|
* result set will be processed in.
|
|
*
|
|
* @param direction The direction in which rows will be processed. The
|
|
* allowed values are the <code>FETCH_*</code> constants
|
|
* defined in this interface.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void setFetchDirection(int direction) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the current fetch direction for this result set.
|
|
*
|
|
* @return The fetch direction for this result set.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
int getFetchDirection() throws SQLException;
|
|
|
|
/**
|
|
* This method provides a hint to the driver about how many rows at a
|
|
* time it should fetch from the database.
|
|
*
|
|
* @param rows The number of rows the driver should fetch per call.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void setFetchSize(int rows) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the current number of rows that will be fetched
|
|
* from the database at a time.
|
|
*
|
|
* @return The current fetch size for this result set.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
int getFetchSize() throws SQLException;
|
|
|
|
/**
|
|
* This method returns the result set type of this result set. This will
|
|
* be one of the <code>TYPE_*</code> constants defined in this interface.
|
|
*
|
|
* @return The result set type.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
int getType() throws SQLException;
|
|
|
|
/**
|
|
* This method returns the concurrency type of this result set. This will
|
|
* be one of the <code>CONCUR_*</code> constants defined in this interface.
|
|
*
|
|
* @return The result set concurrency type.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
int getConcurrency() throws SQLException;
|
|
|
|
/**
|
|
* This method tests whether or not the current row in the result set
|
|
* has been updated. Updates must be visible in order of this method to
|
|
* detect the update.
|
|
*
|
|
* @return <code>true</code> if the row has been updated, <code>false</code>
|
|
* otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean rowUpdated() throws SQLException;
|
|
|
|
/**
|
|
* This method tests whether or not the current row in the result set
|
|
* has been inserted. Inserts must be visible in order of this method to
|
|
* detect the insert.
|
|
*
|
|
* @return <code>true</code> if the row has been inserted, <code>false</code>
|
|
* otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean rowInserted() throws SQLException;
|
|
|
|
/**
|
|
* This method tests whether or not the current row in the result set
|
|
* has been deleted. Deletes must be visible in order of this method to
|
|
* detect the deletion.
|
|
*
|
|
* @return <code>true</code> if the row has been deleted, <code>false</code>
|
|
* otherwise.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
boolean rowDeleted() throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a NULL value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateNull(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a boolean value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateBoolean(int columnIndex, boolean value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a byte value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateByte(int columnIndex, byte value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a short value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateShort(int columnIndex, short value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have an int value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateInt(int columnIndex, int value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a long value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateLong(int columnIndex, long value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a float value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateFloat(int columnIndex, float value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a double value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateDouble(int columnIndex, double value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a BigDecimal value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateBigDecimal(int columnIndex, BigDecimal value)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a String value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateString(int columnIndex, String value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a byte array value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateBytes(int columnIndex, byte[] value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a java.sql.Date value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateDate(int columnIndex, Date value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a java.sql.Time value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateTime(int columnIndex, Time value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a java.sql.Timestamp value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateTimestamp(int columnIndex, Timestamp value)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column from an ASCII text stream.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param stream The stream from which the column value is updated.
|
|
* @param count The length of the stream.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateAsciiStream(int columnIndex, InputStream stream, int count)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column from a binary stream.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param stream The stream from which the column value is updated.
|
|
* @param count The length of the stream.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateBinaryStream(int columnIndex, InputStream stream, int count)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column from a character stream.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param reader The reader from which the column value is updated.
|
|
* @param count The length of the stream.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateCharacterStream(int columnIndex, Reader reader, int count)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have an Object value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @param scale The scale of the object in question, which is used only
|
|
* for numeric type objects.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateObject(int columnIndex, Object value, int scale)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have an Object value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnIndex The index of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateObject(int columnIndex, Object value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a NULL value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateNull(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a boolean value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateBoolean(String columnName, boolean value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a byte value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateByte(String columnName, byte value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a short value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateShort(String columnName, short value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have an int value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateInt(String columnName, int value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a long value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateLong(String columnName, long value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a float value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateFloat(String columnName, float value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a double value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateDouble(String columnName, double value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a BigDecimal value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateBigDecimal(String columnName, BigDecimal value)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a String value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateString(String columnName, String value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a byte array value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateBytes(String columnName, byte[] value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a java.sql.Date value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateDate(String columnName, Date value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a java.sql.Time value. This
|
|
* does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateTime(String columnName, Time value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a java.sql.Timestamp value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateTimestamp(String columnName, Timestamp value)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column from an ASCII text stream.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param stream The stream from which the column value is updated.
|
|
* @param count The length of the stream.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateAsciiStream(String columnName, InputStream stream, int count)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column from a binary stream.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param stream The stream from which the column value is updated.
|
|
* @param count The length of the stream.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateBinaryStream(String columnName, InputStream stream, int count)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column from a character stream.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param reader The reader from which the column value is updated.
|
|
* @param count The length of the stream.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateCharacterStream(String columnName, Reader reader, int count)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have an Object value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @param scale The scale of the object in question, which is used only
|
|
* for numeric type objects.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateObject(String columnName, Object value, int scale)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have an Object value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @param columnName The name of the column to update.
|
|
* @param value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateObject(String columnName, Object value) throws SQLException;
|
|
|
|
/**
|
|
* This method inserts the current row into the database. The result set
|
|
* must be positioned on the insert row in order to call this method
|
|
* successfully.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void insertRow() throws SQLException;
|
|
|
|
/**
|
|
* This method updates the current row in the database.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void updateRow() throws SQLException;
|
|
|
|
/**
|
|
* This method deletes the current row in the database.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void deleteRow() throws SQLException;
|
|
|
|
/**
|
|
* This method refreshes the contents of the current row from the database.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void refreshRow() throws SQLException;
|
|
|
|
/**
|
|
* This method cancels any changes that have been made to a row. If
|
|
* the <code>rowUpdate</code> method has been called, then the changes
|
|
* cannot be undone.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void cancelRowUpdates() throws SQLException;
|
|
|
|
/**
|
|
* This method positions the result set to the "insert row", which allows
|
|
* a new row to be inserted into the database from the result set.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void moveToInsertRow() throws SQLException;
|
|
|
|
/**
|
|
* This method moves the result set position from the insert row back to
|
|
* the current row that was selected prior to moving to the insert row.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
void moveToCurrentRow() throws SQLException;
|
|
|
|
/**
|
|
* This method returns a the <code>Statement</code> that was used to
|
|
* produce this result set.
|
|
*
|
|
* @return The <code>Statement</code> used to produce this result set.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Statement getStatement() throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>Object</code> using the specified SQL type to Java type map.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @param map The SQL type to Java type map to use.
|
|
* @return The value of the column as an <code>Object</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Object getObject(int columnIndex, Map<String, Class<?>> map)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method returns a <code>Ref</code> for the specified column which
|
|
* represents the structured type for the column.
|
|
*
|
|
* @param columnIndex The index of the column to return.
|
|
* @return A <code>Ref</code> object for the column
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Ref getRef(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a BLOB.
|
|
*
|
|
* @param columnIndex The index of the column value to return.
|
|
* @return The value of the column as a BLOB.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Blob getBlob(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a CLOB.
|
|
*
|
|
* @param columnIndex The index of the column value to return.
|
|
* @return The value of the column as a CLOB.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Clob getClob(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as an <code>Array</code>.
|
|
*
|
|
* @param columnIndex The index of the column value to return.
|
|
* @return The value of the column as an <code>Array</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Array getArray(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the value of the specified column as a Java
|
|
* <code>Object</code> using the specified SQL type to Java type map.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @param map The SQL type to Java type map to use.
|
|
* @return The value of the column as an <code>Object</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Object getObject(String columnName, Map<String, Class<?>> map)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method returns a <code>Ref</code> for the specified column which
|
|
* represents the structured type for the column.
|
|
*
|
|
* @param columnName The name of the column to return.
|
|
* @return A <code>Ref</code> object for the column
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Ref getRef(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a BLOB.
|
|
*
|
|
* @param columnName The name of the column value to return.
|
|
* @return The value of the column as a BLOB.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Blob getBlob(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a CLOB.
|
|
*
|
|
* @param columnName The name of the column value to return.
|
|
* @return The value of the column as a CLOB.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Clob getClob(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as an <code>Array</code>.
|
|
*
|
|
* @param columnName The name of the column value to return.
|
|
* @return The value of the column as an <code>Array</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Array getArray(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a
|
|
* <code>java.sql.Date</code>. The specified <code>Calendar</code> is used
|
|
* to generate a value for the date if the database does not support
|
|
* timezones.
|
|
*
|
|
* @param columnIndex The index of the column value to return.
|
|
* @param cal The <code>Calendar</code> to use for calculating timezones.
|
|
* @return The value of the column as a <code>java.sql.Date</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Date getDate(int columnIndex, Calendar cal) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a
|
|
* <code>java.sql.Date</code>. The specified <code>Calendar</code> is used
|
|
* to generate a value for the date if the database does not support
|
|
* timezones.
|
|
*
|
|
* @param columnName The name of the column value to return.
|
|
* @param cal The <code>Calendar</code> to use for calculating timezones.
|
|
* @return The value of the column as a <code>java.sql.Date</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Date getDate(String columnName, Calendar cal) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a
|
|
* <code>java.sql.Time</code>. The specified <code>Calendar</code> is used
|
|
* to generate a value for the time if the database does not support
|
|
* timezones.
|
|
*
|
|
* @param columnIndex The index of the column value to return.
|
|
* @param cal The <code>Calendar</code> to use for calculating timezones.
|
|
* @return The value of the column as a <code>java.sql.Time</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Time getTime(int columnIndex, Calendar cal) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a
|
|
* <code>java.sql.Time</code>. The specified <code>Calendar</code> is used
|
|
* to generate a value for the time if the database does not support
|
|
* timezones.
|
|
*
|
|
* @param columnName The name of the column value to return.
|
|
* @param cal The <code>Calendar</code> to use for calculating timezones.
|
|
* @return The value of the column as a <code>java.sql.Time</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Time getTime(String columnName, Calendar cal) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a
|
|
* <code>java.sql.Timestamp</code>. The specified <code>Calendar</code> is used
|
|
* to generate a value for the timestamp if the database does not support
|
|
* timezones.
|
|
*
|
|
* @param columnIndex The index of the column value to return.
|
|
* @param cal The <code>Calendar</code> to use for calculating timezones.
|
|
* @return The value of the column as a <code>java.sql.Timestamp</code>.
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Timestamp getTimestamp(int columnIndex, Calendar cal)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a
|
|
* <code>java.sql.Timestamp</code>. The specified <code>Calendar</code> is used
|
|
* to generate a value for the timestamp if the database does not support
|
|
* timezones.
|
|
*
|
|
* @param columnName The name of the column value to return.
|
|
* @param cal The <code>Calendar</code> to use for calculating timezones.
|
|
*
|
|
* @return The value of the column as a <code>java.sql.Timestamp</code>.
|
|
*
|
|
* @exception SQLException If an error occurs.
|
|
*/
|
|
Timestamp getTimestamp(String columnName, Calendar cal)
|
|
throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a
|
|
* <code>java.net.URL</code>.
|
|
*
|
|
* @param columnIndex The index of the column value to return.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
URL getURL(int columnIndex) throws SQLException;
|
|
|
|
/**
|
|
* This method returns the specified column value as a
|
|
* <code>java.net.URL</code>.
|
|
*
|
|
* @param columnName The name of the column value to return.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
URL getURL(String columnName) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a
|
|
* <code>java.sql.Ref</code> value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @parm columnIndex The index of the column value to update.
|
|
* @parm value The <code>java.sql.Ref</code> used to set the new value
|
|
* of the column.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
void updateRef(int columnIndex, Ref value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a
|
|
* <code>java.sql.Ref</code> value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @parm columnName The name of the column value to update.
|
|
* @parm value The <code>java.sql.Ref</code> used to set the new value
|
|
* of the column.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
void updateRef(String columnName, Ref value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a
|
|
* <code>java.sql.Blob</code> value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @parm columnIndex The index of the column value to update.
|
|
* @parm value The <code>java.sql.Blob</code> used to set the new value
|
|
* of the column.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
void updateBlob(int columnIndex, Blob value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a
|
|
* <code>java.sql.Blob</code> value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @parm columnName The name of the column value to update.
|
|
* @parm value The <code>java.sql.Blob</code> used to set the new value
|
|
* of the column.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
void updateBlob(String columnName, Blob value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a
|
|
* <code>java.sql.Clob</code> value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @parm columnIndex The index of the column value to update.
|
|
* @parm value The <code>java.sql.Clob</code> used to set the new value
|
|
* of the column.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
void updateClob(int columnIndex, Clob value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a
|
|
* <code>java.sql.Clob</code> value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @parm columnName The name of the column value to update.
|
|
* @parm value The <code>java.sql.Clob</code> used to set the new value
|
|
* of the column.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
void updateClob(String columnName, Clob value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a
|
|
* <code>java.sqlArray</code> value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @parm columnIndex The index of the column value to update.
|
|
* @parm value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
void updateArray(int columnIndex, Array value) throws SQLException;
|
|
|
|
/**
|
|
* This method updates the specified column to have a
|
|
* <code>java.sqlArray</code> value.
|
|
* This does not update the actual database. <code>updateRow</code> must be
|
|
* called in order to do that.
|
|
*
|
|
* @parm columnName The name of the column value to update.
|
|
* @parm value The new value of the column.
|
|
* @exception SQLException If an error occurs.
|
|
* @since 1.4
|
|
*/
|
|
void updateArray(String columnName, Array value) throws SQLException;
|
|
}
|