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.

Note that in this class parameter indices start at 1, not 0.

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()
Returns information about the parameters set on this PreparedStatement (see ParameterMetaData for a detailed description of the provided information).
void
setArray(int index, Array value)
This method sets the specified parameter from the given Java Array value.
void
setAsciiStream(int index, InputStream stream, int count)
This method sets the specified parameter from the given Java ASCII InputStream value.
void
setBigDecimal(int index, BigDecimal value)
This method sets the specified parameter from the given Java java.math.BigDecimal value.
void
setBinaryStream(int index, InputStream stream, int count)
This method sets the specified parameter from the given Java binary InputStream value.
void
setBlob(int index, Blob value)
This method sets the specified parameter from the given Java Blob value.
void
setBoolean(int index, boolean value)
This method sets the specified parameter from the given Java boolean value.
void
setByte(int index, byte value)
This method sets the specified parameter from the given Java byte value.
void
setBytes(int index, byte[] value)
This method sets the specified parameter from the given Java byte array value.
void
setCharacterStream(int index, Reader reader, int count)
This method sets the specified parameter from the given Java character Reader value.
void
setClob(int index, Clob value)
This method sets the specified parameter from the given Java Clob value.
void
setDate(int index, Date value)
This method sets the specified parameter from the given Java java.sql.Date value.
void
setDate(int index, Date value, Calendar cal)
This method sets the specified parameter from the given Java java.sql.Date value.
void
setDouble(int index, double value)
This method sets the specified parameter from the given Java double value.
void
setFloat(int index, float value)
This method sets the specified parameter from the given Java float value.
void
setInt(int index, int value)
This method sets the specified parameter from the given Java int value.
void
setLong(int index, long value)
This method sets the specified parameter from the given Java long value.
void
setNull(int index, int sqlType)
This method populates the specified parameter with a SQL NULL value for the specified type.
void
setNull(int index, int sqlType, String typeName)
This method populates the specified parameter with a SQL NULL value for the specified type.
void
setObject(int index, Object value)
This method sets the specified parameter from the given Java Object value.
void
setObject(int index, Object value, int sqlType)
This method sets the specified parameter from the given Java Object value.
void
setObject(int index, Object value, int sqlType, int scale)
This method sets the specified parameter from the given Java Object value.
void
setRef(int index, Ref value)
This method sets the specified parameter from the given Java Ref value.
void
setShort(int index, short value)
This method sets the specified parameter from the given Java short value.
void
setString(int index, String value)
This method sets the specified parameter from the given Java String value.
void
setTime(int index, Time value)
This method sets the specified parameter from the given Java java.sql.Time value.
void
setTime(int index, Time value, Calendar cal)
This method sets the specified parameter from the given Java java.sql.Time value.
void
setTimestamp(int index, Timestamp value)
This method sets the specified parameter from the given Java java.sql.Timestamp value.
void
setTimestamp(int index, Timestamp value, Calendar cal)
This method sets the specified parameter from the given Java java.sql.Timestamp value.
void
setURL(int index, URL value)
This method sets the specified parameter from the given Java java.net.URL value.
void
setUnicodeStream(int index, InputStream stream, int count)
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
Returns information about the parameters set on this PreparedStatement (see ParameterMetaData for a detailed description of the provided information).
Returns:
Meta data for the parameters of this statement.
Since:
1.4

setArray

public void setArray(int index,
                     Array value)
            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:
index - The index of the parameter value to set.
value - The value of the parameter.
Throws:
SQLException - If an error occurs.

setAsciiStream

public void setAsciiStream(int index,
                           InputStream stream,
                           int count)
            throws SQLException
This method sets the specified parameter from the given Java ASCII InputStream value.
Parameters:
index - The index of the parameter value to set.
stream - The stream from which the parameter value is read.
count - The number of bytes in the stream.
Throws:
SQLException - If an error occurs.

setBigDecimal

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

setBinaryStream

public void setBinaryStream(int index,
                            InputStream stream,
                            int count)
            throws SQLException
This method sets the specified parameter from the given Java binary InputStream value.
Parameters:
index - The index of the parameter value to set.
stream - The stream from which the parameter value is read.
count - The number of bytes in the stream.
Throws:
SQLException - If an error occurs.

setBlob

public void setBlob(int index,
                    Blob value)
            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:
index - The index of the parameter value to set.
value - The Blob used to set the value of the parameter.
Throws:
SQLException - If an error occurs.

setBoolean

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

setByte

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

setBytes

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

setCharacterStream

public void setCharacterStream(int index,
                               Reader reader,
                               int count)
            throws SQLException
This method sets the specified parameter from the given Java character Reader value.
Parameters:
index - The index of the parameter value to set.
reader - The reader from which the parameter value is read.
count - The number of characters in the stream.
Throws:
SQLException - If an error occurs.

setClob

public void setClob(int index,
                    Clob value)
            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:
index - The index of the parameter value to set.
value - The Clob used to set the value of the parameter.
Throws:
SQLException - If an error occurs.

setDate

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

setDate

public void setDate(int index,
                    Date value,
                    Calendar cal)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Date value.
Parameters:
index - The index of the parameter value to set.
value - The value of the parameter.
cal - The Calendar to use for timezone and locale.
Throws:
SQLException - If an error occurs.

setDouble

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

setFloat

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

setInt

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

setLong

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

setNull

public void setNull(int index,
                    int sqlType)
            throws SQLException
This method populates the specified parameter with a SQL NULL value for the specified type.
Parameters:
index - The index of the parameter to set.
sqlType - The SQL type identifier of the parameter from Types
Throws:
SQLException - If an error occurs.

setNull

public void setNull(int index,
                    int sqlType,
                    String typeName)
            throws SQLException
This method populates the specified parameter with a SQL NULL value for the specified type.
Parameters:
index - The index of the parameter to set.
sqlType - The SQL type identifier of the parameter from Types
typeName - The name of the data type, for user defined types.
Throws:
SQLException - If an error occurs.

setObject

public void setObject(int index,
                      Object value)
            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:
index - The index of the parameter value to set.
value - The value of the parameter.
Throws:
SQLException - If an error occurs.

setObject

public void setObject(int index,
                      Object value,
                      int sqlType)
            throws SQLException
This method sets the specified parameter from the given Java Object value. The specified SQL object type will be used.
Parameters:
index - The index of the parameter value to set.
value - The value of the parameter.
sqlType - The SQL type to use for the parameter, from Types
Throws:
SQLException - If an error occurs.
See Also:
Types

setObject

public void setObject(int index,
                      Object value,
                      int sqlType,
                      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:
index - The index of the parameter value to set.
value - The value of the parameter.
sqlType - The SQL type to use for the parameter, from Types
scale - The scale of the value, for numeric values only.
Throws:
SQLException - If an error occurs.
See Also:
Types

setRef

public void setRef(int index,
                   Ref value)
            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:
index - The index of the parameter value to set.
value - The Ref used to set the value of the parameter.
Throws:
SQLException - If an error occurs.

setShort

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

setString

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

setTime

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

setTime

public void setTime(int index,
                    Time value,
                    Calendar cal)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Time value.
Parameters:
index - The index of the parameter value to set.
value - The value of the parameter.
cal - The Calendar to use for timezone and locale.
Throws:
SQLException - If an error occurs.

setTimestamp

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

setTimestamp

public void setTimestamp(int index,
                         Timestamp value,
                         Calendar cal)
            throws SQLException
This method sets the specified parameter from the given Java java.sql.Timestamp value.
Parameters:
index - The index of the parameter value to set.
value - The value of the parameter.
cal - The Calendar to use for timezone and locale.
Throws:
SQLException - If an error occurs.

setURL

public void setURL(int index,
                   URL value)
            throws SQLException
This method sets the specified parameter from the given Java java.net.URL value.
Parameters:
index - The index of the parameter to set.
value - The value of the parameter.
Throws:
SQLException - If an error occurs.
Since:
1.4

setUnicodeStream

public void setUnicodeStream(int index,
                             InputStream stream,
                             int count)
            throws SQLException

Deprecated.

This method sets the specified parameter from the given Java Unicode UTF-8 InputStream value.
Parameters:
index - The index of the parameter value to set.
stream - The stream from which the parameter value is read.
count - The number of bytes in the stream.
Throws:
SQLException - If an error occurs.

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