java.sql

Interface PreparedStatement

All Superinterfaces:
Statement
Known Subinterfaces:
CallableStatement

public interface PreparedStatement
extends Statement

This interface provides a mechanism for executing pre-compiled statements. This provides greater efficiency when calling the same statement multiple times. Parameters are allowed in a statement, providings for maximum reusability.

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary

void
addBatch()
This method adds a set of parameters to the batch for JDBC 2.0.
void
clearParameters()
This method clears all of the input parameter that have been set on this statement.
boolean
execute()
This method executes a prepared SQL query.
ResultSet
executeQuery()
This method executes a prepared SQL query and returns its ResultSet.
int
executeUpdate()
This method executes an SQL INSERT, UPDATE or DELETE statement.
ResultSetMetaData
getMetaData()
This method returns meta data for the result set from this statement.
ParameterMetaData
getParameterMetaData()
void
setArray(int i, Array x)
This method sets the specified parameter from the given Java Array value.
void
setAsciiStream(int parameterIndex, InputStream x, int length)
This method sets the specified parameter from the given Java ASCII InputStream value.
void
setBigDecimal(int parameterIndex, BigDecimal x)
This method sets the specified parameter from the given Java java.math.BigDecimal value.
void
setBinaryStream(int parameterIndex, InputStream x, int length)
This method sets the specified parameter from the given Java binary InputStream value.
void
setBlob(int i, Blob x)
This method sets the specified parameter from the given Java Blob value.
void
setBoolean(int parameterIndex, boolean x)
This method sets the specified parameter from the given Java boolean value.
void
setByte(int parameterIndex, byte x)
This method sets the specified parameter from the given Java byte value.
void
setBytes(int parameterIndex, byte[] x)
This method sets the specified parameter from the given Java byte array value.
void
setCharacterStream(int parameterIndex, Reader reader, int length)
This method sets the specified parameter from the given Java character Reader value.
void
setClob(int i, Clob x)
This method sets the specified parameter from the given Java Clob value.
void
setDate(int parameterIndex, Date x)
This method sets the specified parameter from the given Java java.sql.Date value.
void
setDate(int parameterIndex, Date x, Calendar cal)
This method sets the specified parameter from the given Java java.sql.Date value.
void
setDouble(int parameterIndex, double x)
This method sets the specified parameter from the given Java double value.
void
setFloat(int parameterIndex, float x)
This method sets the specified parameter from the given Java float value.
void
setInt(int parameterIndex, int x)
This method sets the specified parameter from the given Java int value.
void
setLong(int parameterIndex, long x)
This method sets the specified parameter from the given Java long value.
void
setNull(int parameterIndex, int sqlType)
This method populates the specified parameter with a SQL NULL value for the specified type.
void
setNull(int paramIndex, int sqlType, String typeName)
This method populates the specified parameter with a SQL NULL value for the specified type.
void
setObject(int parameterIndex, Object x)
This method sets the specified parameter from the given Java Object value.
void
setObject(int parameterIndex, Object x, int targetSqlType)
This method sets the specified parameter from the given Java Object value.
void
setObject(int parameterIndex, Object x, int targetSqlType, int scale)
This method sets the specified parameter from the given Java Object value.
void
setRef(int i, Ref x)
This method sets the specified parameter from the given Java Ref value.
void
setShort(int parameterIndex, short x)
This method sets the specified parameter from the given Java short value.
void
setString(int parameterIndex, String x)
This method sets the specified parameter from the given Java String value.
void
setTime(int parameterIndex, Time x)
This method sets the specified parameter from the given Java java.sql.Time value.
void
setTime(int parameterIndex, Time x, Calendar cal)
This method sets the specified parameter from the given Java java.sql.Time value.
void
setTimestamp(int parameterIndex, Timestamp x)
This method sets the specified parameter from the given Java java.sql.Timestamp value.
void
setTimestamp(int parameterIndex, Timestamp x, Calendar cal)
This method sets the specified parameter from the given Java java.sql.Timestamp value.
void
setURL(int parameterIndex, URL x)
void
setUnicodeStream(int parameterIndex, InputStream x, int length)
Deprecated.

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Method Details

addBatch

public void addBatch()
            throws SQLException
This method adds a set of parameters to the batch for JDBC 2.0.
Throws:
SQLException - If an error occurs.

clearParameters

public void clearParameters()
            throws SQLException
This method clears all of the input parameter that have been set on this statement.
Throws:
SQLException - If an error occurs.

execute

public boolean execute()
            throws SQLException
This method executes a prepared SQL query. Some prepared statements return multiple results; the execute method handles these complex statements as well as the simpler form of statements handled by executeQuery and executeUpdate.
Returns:
The result of the SQL statement.
Throws:
SQLException - If an error occurs.

executeQuery

public ResultSet executeQuery()
            throws SQLException
This method executes a prepared SQL query and returns its ResultSet.
Returns:
The ResultSet of the SQL statement.
Throws:
SQLException - If an error occurs.

executeUpdate

public int executeUpdate()
            throws SQLException
This method executes an SQL INSERT, UPDATE or DELETE statement. SQL statements that return nothing such as SQL DDL statements can be executed.
Returns:
The result is either the row count for INSERT, UPDATE or DELETE statements; or 0 for SQL statements that return nothing.
Throws:
SQLException - If an error occurs.

getMetaData

public ResultSetMetaData getMetaData()
            throws SQLException
This method returns meta data for the result set from this statement.
Returns:
Meta data for the result set from this statement.
Throws:
SQLException - If an error occurs.

getParameterMetaData

public ParameterMetaData getParameterMetaData()
            throws SQLException
Since:
1.4

setArray

public void setArray(int i,
                     Array x)
            throws SQLException
This method sets the specified parameter from the given Java Array value. The default object type to SQL type mapping will be used.
Parameters:
Throws:
SQLException - If an error occurs.

setAsciiStream

public void setAsciiStream(int parameterIndex,
                           InputStream x,
                           int length)
            throws SQLException
This method sets the specified parameter from the given Java ASCII InputStream value.
Parameters:
length - The number of bytes in the stream.
Throws:
SQLException - If an error occurs.

setBigDecimal

public void setBigDecimal(int parameterIndex,
                          BigDecimal x)
            throws SQLException
This method sets the specified parameter from the given Java java.math.BigDecimal value.
Parameters:
Throws:
SQLException - If an error occurs.

setBinaryStream

public void setBinaryStream(int parameterIndex,
                            InputStream x,
                            int length)
            throws SQLException
This method sets the specified parameter from the given Java binary InputStream value.
Parameters:
length - The number of bytes in the stream.
Throws:
SQLException - If an error occurs.

setBlob

public void setBlob(int i,
                    Blob x)
            throws SQLException
This method sets the specified parameter from the given Java Blob value. The default object type to SQL type mapping will be used.
Parameters:
Throws:
SQLException - If an error occurs.

setBoolean

public void setBoolean(int parameterIndex,
                       boolean x)
            throws SQLException
This method sets the specified parameter from the given Java boolean value.
Parameters:
Throws:
SQLException - If an error occurs.

setByte

public void setByte(int parameterIndex,
                    byte x)
            throws SQLException
This method sets the specified parameter from the given Java byte value.
Parameters:
Throws:
SQLException - If an error occurs.

setBytes

public void setBytes(int parameterIndex,
                     byte[] x)
            throws SQLException
This method sets the specified parameter from the given Java byte array value.
Parameters:
Throws:
SQLException - If an error occurs.

setCharacterStream

public void setCharacterStream(int parameterIndex,
                               Reader reader,
                               int length)
            throws SQLException
This method sets the specified parameter from the given Java character Reader value.
Parameters:
length - The number of bytes in the stream.
Throws:
SQLException - If an error occurs.

setClob

public void setClob(int i,
                    Clob x)
            throws SQLException
This method sets the specified parameter from the given Java Clob value. The default object type to SQL type mapping will be used.
Parameters:
Throws:
SQLException - If an error occurs.

setDate

public void setDate(int parameterIndex,
                    Date x)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Date value.
Parameters:
Throws:
SQLException - If an error occurs.

setDate

public void setDate(int parameterIndex,
                    Date x,
                    Calendar cal)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Date value.
Parameters:
Throws:
SQLException - If an error occurs.

setDouble

public void setDouble(int parameterIndex,
                      double x)
            throws SQLException
This method sets the specified parameter from the given Java double value.
Parameters:
Throws:
SQLException - If an error occurs.

setFloat

public void setFloat(int parameterIndex,
                     float x)
            throws SQLException
This method sets the specified parameter from the given Java float value.
Parameters:
Throws:
SQLException - If an error occurs.

setInt

public void setInt(int parameterIndex,
                   int x)
            throws SQLException
This method sets the specified parameter from the given Java int value.
Parameters:
Throws:
SQLException - If an error occurs.

setLong

public void setLong(int parameterIndex,
                    long x)
            throws SQLException
This method sets the specified parameter from the given Java long value.
Parameters:
Throws:
SQLException - If an error occurs.

setNull

public void setNull(int parameterIndex,
                    int sqlType)
            throws SQLException
This method populates the specified parameter with a SQL NULL value for the specified type.
Parameters:
Throws:
SQLException - If an error occurs.

setNull

public void setNull(int paramIndex,
                    int sqlType,
                    String typeName)
            throws SQLException
This method populates the specified parameter with a SQL NULL value for the specified type.
Parameters:
Throws:
SQLException - If an error occurs.

setObject

public void setObject(int parameterIndex,
                      Object x)
            throws SQLException
This method sets the specified parameter from the given Java Object value. The default object type to SQL type mapping will be used.
Parameters:
Throws:
SQLException - If an error occurs.

setObject

public void setObject(int parameterIndex,
                      Object x,
                      int targetSqlType)
            throws SQLException
This method sets the specified parameter from the given Java Object value. The specified SQL object type will be used.
Parameters:
Throws:
SQLException - If an error occurs.
See Also:
Types

setObject

public void setObject(int parameterIndex,
                      Object x,
                      int targetSqlType,
                      int scale)
            throws SQLException
This method sets the specified parameter from the given Java Object value. The specified SQL object type will be used.
Parameters:
scale - The scale of the value, for numeric values only.
Throws:
SQLException - If an error occurs.
See Also:
Types

setRef

public void setRef(int i,
                   Ref x)
            throws SQLException
This method sets the specified parameter from the given Java Ref value. The default object type to SQL type mapping will be used.
Parameters:
Throws:
SQLException - If an error occurs.

setShort

public void setShort(int parameterIndex,
                     short x)
            throws SQLException
This method sets the specified parameter from the given Java short value.
Parameters:
Throws:
SQLException - If an error occurs.

setString

public void setString(int parameterIndex,
                      String x)
            throws SQLException
This method sets the specified parameter from the given Java String value.
Parameters:
Throws:
SQLException - If an error occurs.

setTime

public void setTime(int parameterIndex,
                    Time x)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Time value.
Parameters:
Throws:
SQLException - If an error occurs.

setTime

public void setTime(int parameterIndex,
                    Time x,
                    Calendar cal)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Time value.
Parameters:
Throws:
SQLException - If an error occurs.

setTimestamp

public void setTimestamp(int parameterIndex,
                         Timestamp x)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Timestamp value.
Parameters:
Throws:
SQLException - If an error occurs.

setTimestamp

public void setTimestamp(int parameterIndex,
                         Timestamp x,
                         Calendar cal)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Timestamp value.
Parameters:
Throws:
SQLException - If an error occurs.

setURL

public void setURL(int parameterIndex,
                   URL x)
            throws SQLException
Since:
1.4

setUnicodeStream

public void setUnicodeStream(int parameterIndex,
                             InputStream x,
                             int length)
            throws SQLException

Deprecated.

This method sets the specified parameter from the given Java Unicode UTF-8 InputStream value.
Parameters:
length - The number of bytes in the stream.
Throws:
SQLException - If an error occurs.

PreparedStatement.java -- Interface for pre-compiled statements. Copyright (C) 1999, 2000 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.