- All Superinterfaces:
AutoCloseable
,ResultSet
,Wrapper
- All Known Subinterfaces:
CachedRowSet
,FilteredRowSet
,JdbcRowSet
,JoinRowSet
,SyncResolver
,WebRowSet
public interface RowSet extends ResultSet
The RowSet
interface provides a set of JavaBeans properties that allow a RowSet
instance to be configured to connect to a JDBC data source and read
some data from the data source. A group of setter methods (setInt
,
setBytes
, setString
, and so on)
provide a way to pass input parameters to a rowset's command property.
This command is the SQL query the rowset uses when it gets its data from
a relational database, which is generally the case.
The RowSet
interface supports JavaBeans events, allowing other components in an
application to be notified when an event occurs on a rowset,
such as a change in its value.
The RowSet
interface is unique in that it is intended to be
implemented using the rest of the JDBC API. In other words, a
RowSet
implementation is a layer of software that executes "on top"
of a JDBC driver. Implementations of the RowSet
interface can
be provided by anyone, including JDBC driver vendors who want to
provide a RowSet
implementation as part of their JDBC products.
A RowSet
object may make a connection with a data source and
maintain that connection throughout its life cycle, in which case it is
called a connected rowset. A rowset may also make a connection with
a data source, get data from it, and then close the connection. Such a rowset
is called a disconnected rowset. A disconnected rowset may make
changes to its data while it is disconnected and then send the changes back
to the original source of the data, but it must reestablish a connection to do so.
A disconnected rowset may have a Reader
(a RowSetReader
object)
and a writer (a RowSetWriter
object) associated with it.
The Reader
may be implemented in many different ways to populate a rowset
with data, including getting data from a non-relational data source. The
writer can also be implemented in many different ways to propagate changes
made to the rowset's data back to the underlying data source.
Rowsets are easy to use. The RowSet
interface extends the standard
java.sql.ResultSet
interface. The RowSetMetaData
interface extends the java.sql.ResultSetMetaData
interface.
Thus, developers familiar
with the JDBC API will have to learn a minimal number of new APIs to
use rowsets. In addition, third-party software tools that work with
JDBC ResultSet
objects will also easily be made to work with rowsets.
- Since:
- 1.4
-
Field Summary
Fields declared in interface java.sql.ResultSet
CLOSE_CURSORS_AT_COMMIT, CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, HOLD_CURSORS_OVER_COMMIT, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE
-
Method Summary
Modifier and Type Method Description void
addRowSetListener(RowSetListener listener)
Registers the given listener so that it will be notified of events that occur on thisRowSet
object.void
clearParameters()
Clears the parameters set for thisRowSet
object's command.void
execute()
Fills thisRowSet
object with data.String
getCommand()
Retrieves thisRowSet
object's command property.String
getDataSourceName()
Retrieves the logical name that identifies the data source for thisRowSet
object.boolean
getEscapeProcessing()
Retrieves whether escape processing is enabled for thisRowSet
object.int
getMaxFieldSize()
Retrieves the maximum number of bytes that may be returned for certain column values.int
getMaxRows()
Retrieves the maximum number of rows that thisRowSet
object can contain.String
getPassword()
Retrieves the password used to create a database connection.int
getQueryTimeout()
Retrieves the maximum number of seconds the driver will wait for a statement to execute.int
getTransactionIsolation()
Retrieves the transaction isolation level set for thisRowSet
object.Map<String,Class<?>>
getTypeMap()
Retrieves theMap
object associated with thisRowSet
object, which specifies the custom mapping of SQL user-defined types, if any.String
getUrl()
Retrieves the url property thisRowSet
object will use to create a connection if it uses theDriverManager
instead of aDataSource
object to establish the connection.String
getUsername()
Retrieves the username used to create a database connection for thisRowSet
object.boolean
isReadOnly()
Retrieves whether thisRowSet
object is read-only.void
removeRowSetListener(RowSetListener listener)
Removes the specified listener from the list of components that will be notified when an event occurs on thisRowSet
object.void
setArray(int i, Array x)
Sets the designated parameter in thisRowSet
object's command with the givenArray
value.void
setAsciiStream(int parameterIndex, InputStream x)
Sets the designated parameter in thisRowSet
object's command to the given input stream.void
setAsciiStream(int parameterIndex, InputStream x, int length)
Sets the designated parameter in thisRowSet
object's command to the givenjava.io.InputStream
value.void
setAsciiStream(String parameterName, InputStream x)
Sets the designated parameter to the given input stream.void
setAsciiStream(String parameterName, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBigDecimal(int parameterIndex, BigDecimal x)
Sets the designated parameter in thisRowSet
object's command to the givenjava.math.BigDecimal
value.void
setBigDecimal(String parameterName, BigDecimal x)
Sets the designated parameter to the givenjava.math.BigDecimal
value.void
setBinaryStream(int parameterIndex, InputStream x)
Sets the designated parameter in thisRowSet
object's command to the given input stream.void
setBinaryStream(int parameterIndex, InputStream x, int length)
Sets the designated parameter in thisRowSet
object's command to the givenjava.io.InputStream
value.void
setBinaryStream(String parameterName, InputStream x)
Sets the designated parameter to the given input stream.void
setBinaryStream(String parameterName, InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBlob(int parameterIndex, InputStream inputStream)
Sets the designated parameter to aInputStream
object.void
setBlob(int parameterIndex, InputStream inputStream, long length)
Sets the designated parameter to aInputStream
object.void
setBlob(int i, Blob x)
Sets the designated parameter in thisRowSet
object's command with the givenBlob
value.void
setBlob(String parameterName, InputStream inputStream)
Sets the designated parameter to aInputStream
object.void
setBlob(String parameterName, InputStream inputStream, long length)
Sets the designated parameter to aInputStream
object.void
setBlob(String parameterName, Blob x)
Sets the designated parameter to the givenjava.sql.Blob
object.void
setBoolean(int parameterIndex, boolean x)
Sets the designated parameter in thisRowSet
object's command to the given Javaboolean
value.void
setBoolean(String parameterName, boolean x)
Sets the designated parameter to the given Javaboolean
value.void
setByte(int parameterIndex, byte x)
Sets the designated parameter in thisRowSet
object's command to the given Javabyte
value.void
setByte(String parameterName, byte x)
Sets the designated parameter to the given Javabyte
value.void
setBytes(int parameterIndex, byte[] x)
Sets the designated parameter in thisRowSet
object's command to the given Java array ofbyte
values.void
setBytes(String parameterName, byte[] x)
Sets the designated parameter to the given Java array of bytes.void
setCharacterStream(int parameterIndex, Reader reader)
Sets the designated parameter in thisRowSet
object's command to the givenReader
object.void
setCharacterStream(int parameterIndex, Reader reader, int length)
Sets the designated parameter in thisRowSet
object's command to the givenjava.io.Reader
value.void
setCharacterStream(String parameterName, Reader reader)
Sets the designated parameter to the givenReader
object.void
setCharacterStream(String parameterName, Reader reader, int length)
Sets the designated parameter to the givenReader
object, which is the given number of characters long.void
setClob(int parameterIndex, Reader reader)
Sets the designated parameter to aReader
object.void
setClob(int parameterIndex, Reader reader, long length)
Sets the designated parameter to aReader
object.void
setClob(int i, Clob x)
Sets the designated parameter in thisRowSet
object's command with the givenClob
value.void
setClob(String parameterName, Reader reader)
Sets the designated parameter to aReader
object.void
setClob(String parameterName, Reader reader, long length)
Sets the designated parameter to aReader
object.void
setClob(String parameterName, Clob x)
Sets the designated parameter to the givenjava.sql.Clob
object.void
setCommand(String cmd)
Sets thisRowSet
object's command property to the given SQL query.void
setConcurrency(int concurrency)
Sets the concurrency of thisRowSet
object to the given concurrency level.void
setDataSourceName(String name)
Sets the data source name property for thisRowSet
object to the givenString
.void
setDate(int parameterIndex, Date x)
Sets the designated parameter in thisRowSet
object's command to the givenjava.sql.Date
value.void
setDate(int parameterIndex, Date x, Calendar cal)
Sets the designated parameter in thisRowSet
object's command with the givenjava.sql.Date
value.void
setDate(String parameterName, Date x)
Sets the designated parameter to the givenjava.sql.Date
value using the default time zone of the virtual machine that is running the application.void
setDate(String parameterName, Date x, Calendar cal)
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object.void
setDouble(int parameterIndex, double x)
Sets the designated parameter in thisRowSet
object's command to the given Javadouble
value.void
setDouble(String parameterName, double x)
Sets the designated parameter to the given Javadouble
value.void
setEscapeProcessing(boolean enable)
Sets escape processing for thisRowSet
object on or off.void
setFloat(int parameterIndex, float x)
Sets the designated parameter in thisRowSet
object's command to the given Javafloat
value.void
setFloat(String parameterName, float x)
Sets the designated parameter to the given Javafloat
value.void
setInt(int parameterIndex, int x)
Sets the designated parameter in thisRowSet
object's command to the given Javaint
value.void
setInt(String parameterName, int x)
Sets the designated parameter to the given Javaint
value.void
setLong(int parameterIndex, long x)
Sets the designated parameter in thisRowSet
object's command to the given Javalong
value.void
setLong(String parameterName, long x)
Sets the designated parameter to the given Javalong
value.void
setMaxFieldSize(int max)
Sets the maximum number of bytes that can be returned for a column value to the given number of bytes.void
setMaxRows(int max)
Sets the maximum number of rows that thisRowSet
object can contain to the specified number.void
setNCharacterStream(int parameterIndex, Reader value)
Sets the designated parameter in thisRowSet
object's command to aReader
object.void
setNCharacterStream(int parameterIndex, Reader value, long length)
Sets the designated parameter to aReader
object.void
setNCharacterStream(String parameterName, Reader value)
Sets the designated parameter to aReader
object.void
setNCharacterStream(String parameterName, Reader value, long length)
Sets the designated parameter to aReader
object.void
setNClob(int parameterIndex, Reader reader)
Sets the designated parameter to aReader
object.void
setNClob(int parameterIndex, Reader reader, long length)
Sets the designated parameter to aReader
object.void
setNClob(int parameterIndex, NClob value)
Sets the designated parameter to ajava.sql.NClob
object.void
setNClob(String parameterName, Reader reader)
Sets the designated parameter to aReader
object.void
setNClob(String parameterName, Reader reader, long length)
Sets the designated parameter to aReader
object.void
setNClob(String parameterName, NClob value)
Sets the designated parameter to ajava.sql.NClob
object.void
setNString(int parameterIndex, String value)
Sets the designated parameter to the givenString
object.void
setNString(String parameterName, String value)
Sets the designated parameter to the givenString
object.void
setNull(int parameterIndex, int sqlType)
Sets the designated parameter in thisRowSet
object's SQL command to SQLNULL
.void
setNull(int paramIndex, int sqlType, String typeName)
Sets the designated parameter in thisRowSet
object's SQL command to SQLNULL
.void
setNull(String parameterName, int sqlType)
Sets the designated parameter to SQLNULL
.void
setNull(String parameterName, int sqlType, String typeName)
Sets the designated parameter to SQLNULL
.void
setObject(int parameterIndex, Object x)
Sets the designated parameter in thisRowSet
object's command with a JavaObject
.void
setObject(int parameterIndex, Object x, int targetSqlType)
Sets the designated parameter in thisRowSet
object's command with a JavaObject
.void
setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength)
Sets the designated parameter in thisRowSet
object's command with the given JavaObject
.void
setObject(String parameterName, Object x)
Sets the value of the designated parameter with the given object.void
setObject(String parameterName, Object x, int targetSqlType)
Sets the value of the designated parameter with the given object.void
setObject(String parameterName, Object x, int targetSqlType, int scale)
Sets the value of the designated parameter with the given object.void
setPassword(String password)
Sets the database password for thisRowSet
object to the givenString
.void
setQueryTimeout(int seconds)
Sets the maximum time the driver will wait for a statement to execute to the given number of seconds.void
setReadOnly(boolean value)
Sets whether thisRowSet
object is read-only to the givenboolean
.void
setRef(int i, Ref x)
Sets the designated parameter in thisRowSet
object's command with the givenRef
value.void
setRowId(int parameterIndex, RowId x)
Sets the designated parameter to the givenjava.sql.RowId
object.void
setRowId(String parameterName, RowId x)
Sets the designated parameter to the givenjava.sql.RowId
object.void
setShort(int parameterIndex, short x)
Sets the designated parameter in thisRowSet
object's command to the given Javashort
value.void
setShort(String parameterName, short x)
Sets the designated parameter to the given Javashort
value.void
setSQLXML(int parameterIndex, SQLXML xmlObject)
Sets the designated parameter to the givenjava.sql.SQLXML
object.void
setSQLXML(String parameterName, SQLXML xmlObject)
Sets the designated parameter to the givenjava.sql.SQLXML
object.void
setString(int parameterIndex, String x)
Sets the designated parameter in thisRowSet
object's command to the given JavaString
value.void
setString(String parameterName, String x)
Sets the designated parameter to the given JavaString
value.void
setTime(int parameterIndex, Time x)
Sets the designated parameter in thisRowSet
object's command to the givenjava.sql.Time
value.void
setTime(int parameterIndex, Time x, Calendar cal)
Sets the designated parameter in thisRowSet
object's command with the givenjava.sql.Time
value.void
setTime(String parameterName, Time x)
Sets the designated parameter to the givenjava.sql.Time
value.void
setTime(String parameterName, Time x, Calendar cal)
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object.void
setTimestamp(int parameterIndex, Timestamp x)
Sets the designated parameter in thisRowSet
object's command to the givenjava.sql.Timestamp
value.void
setTimestamp(int parameterIndex, Timestamp x, Calendar cal)
Sets the designated parameter in thisRowSet
object's command with the givenjava.sql.Timestamp
value.void
setTimestamp(String parameterName, Timestamp x)
Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setTimestamp(String parameterName, Timestamp x, Calendar cal)
Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object.void
setTransactionIsolation(int level)
Sets the transaction isolation level for thisRowSet
object.void
setType(int type)
Sets the type of thisRowSet
object to the given type.void
setTypeMap(Map<String,Class<?>> map)
Installs the givenjava.util.Map
object as the default type map for thisRowSet
object.void
setUrl(String url)
Sets the URL thisRowSet
object will use when it uses theDriverManager
to create a connection.void
setURL(int parameterIndex, URL x)
Sets the designated parameter to the givenjava.net.URL
value.void
setUsername(String name)
Sets the username property for thisRowSet
object to the givenString
.Methods declared in interface java.sql.ResultSet
absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, getDate, getDate, getDate, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getHoldability, getInt, getInt, getLong, getLong, getMetaData, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getStatement, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertRow, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, updateArray, updateArray, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateClob, updateClob, updateClob, updateClob, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNString, updateNString, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateObject, updateRef, updateRef, updateRow, updateRowId, updateRowId, updateShort, updateShort, updateSQLXML, updateSQLXML, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNull
-
Method Details
-
getUrl
Retrieves the url property thisRowSet
object will use to create a connection if it uses theDriverManager
instead of aDataSource
object to establish the connection. The default value isnull
.- Returns:
- a string url
- Throws:
SQLException
- if a database access error occurs- See Also:
setUrl(java.lang.String)
-
setUrl
Sets the URL thisRowSet
object will use when it uses theDriverManager
to create a connection. Setting this property is optional. If a URL is used, a JDBC driver that accepts the URL must be loaded before the rowset is used to connect to a database. The rowset will use the URL internally to create a database connection when reading or writing data. Either a URL or a data source name is used to create a connection, whichever was set to non null value most recently.- Parameters:
url
- a string value; may benull
- Throws:
SQLException
- if a database access error occurs- See Also:
getUrl()
-
getDataSourceName
String getDataSourceName()Retrieves the logical name that identifies the data source for thisRowSet
object.- Returns:
- a data source name
- See Also:
setDataSourceName(java.lang.String)
,setUrl(java.lang.String)
-
setDataSourceName
Sets the data source name property for thisRowSet
object to the givenString
.The value of the data source name property can be used to do a lookup of a
DataSource
object that has been registered with a naming service. After being retrieved, theDataSource
object can be used to create a connection to the data source that it represents.- Parameters:
name
- the logical name of the data source for thisRowSet
object; may benull
- Throws:
SQLException
- if a database access error occurs- See Also:
getDataSourceName()
-
getUsername
String getUsername()Retrieves the username used to create a database connection for thisRowSet
object. The username property is set at run time before calling the methodexecute
. It is not usually part of the serialized state of aRowSet
object.- Returns:
- the username property
- See Also:
setUsername(java.lang.String)
-
setUsername
Sets the username property for thisRowSet
object to the givenString
.- Parameters:
name
- a user name- Throws:
SQLException
- if a database access error occurs- See Also:
getUsername()
-
getPassword
String getPassword()Retrieves the password used to create a database connection. The password property is set at run time before calling the methodexecute
. It is not usually part of the serialized state of aRowSet
object.- Returns:
- the password for making a database connection
- See Also:
setPassword(java.lang.String)
-
setPassword
Sets the database password for thisRowSet
object to the givenString
.- Parameters:
password
- the password string- Throws:
SQLException
- if a database access error occurs- See Also:
getPassword()
-
getTransactionIsolation
int getTransactionIsolation()Retrieves the transaction isolation level set for thisRowSet
object.- Returns:
- the transaction isolation level; one of
Connection.TRANSACTION_READ_UNCOMMITTED
,Connection.TRANSACTION_READ_COMMITTED
,Connection.TRANSACTION_REPEATABLE_READ
, orConnection.TRANSACTION_SERIALIZABLE
- See Also:
setTransactionIsolation(int)
-
setTransactionIsolation
Sets the transaction isolation level for thisRowSet
object.- Parameters:
level
- the transaction isolation level; one ofConnection.TRANSACTION_READ_UNCOMMITTED
,Connection.TRANSACTION_READ_COMMITTED
,Connection.TRANSACTION_REPEATABLE_READ
, orConnection.TRANSACTION_SERIALIZABLE
- Throws:
SQLException
- if a database access error occurs- See Also:
getTransactionIsolation()
-
getTypeMap
Retrieves theMap
object associated with thisRowSet
object, which specifies the custom mapping of SQL user-defined types, if any. The default is for the type map to be empty.- Returns:
- a
java.util.Map
object containing the names of SQL user-defined types and the Java classes to which they are to be mapped - Throws:
SQLException
- if a database access error occurs- See Also:
setTypeMap(java.util.Map<java.lang.String, java.lang.Class<?>>)
-
setTypeMap
Installs the givenjava.util.Map
object as the default type map for thisRowSet
object. This type map will be used unless another type map is supplied as a method parameter.- Parameters:
map
- ajava.util.Map
object containing the names of SQL user-defined types and the Java classes to which they are to be mapped- Throws:
SQLException
- if a database access error occurs- See Also:
getTypeMap()
-
getCommand
String getCommand()Retrieves thisRowSet
object's command property. The command property contains a command string, which must be an SQL query, that can be executed to fill the rowset with data. The default value isnull
.- Returns:
- the command string; may be
null
- See Also:
setCommand(java.lang.String)
-
setCommand
Sets thisRowSet
object's command property to the given SQL query. This property is optional when a rowset gets its data from a data source that does not support commands, such as a spreadsheet.- Parameters:
cmd
- the SQL query that will be used to get the data for thisRowSet
object; may benull
- Throws:
SQLException
- if a database access error occurs- See Also:
getCommand()
-
isReadOnly
boolean isReadOnly()Retrieves whether thisRowSet
object is read-only. If updates are possible, the default is for a rowset to be updatable.Attempts to update a read-only rowset will result in an
SQLException
being thrown.- Returns:
true
if thisRowSet
object is read-only;false
if it is updatable- See Also:
setReadOnly(boolean)
-
setReadOnly
Sets whether thisRowSet
object is read-only to the givenboolean
.- Parameters:
value
-true
if read-only;false
if updatable- Throws:
SQLException
- if a database access error occurs- See Also:
isReadOnly()
-
getMaxFieldSize
Retrieves the maximum number of bytes that may be returned for certain column values. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARYBINARY
,CHAR
,VARCHAR
,LONGVARCHAR
,NCHAR
andNVARCHAR
columns. If the limit is exceeded, the excess data is silently discarded.- Returns:
- the current maximum column size limit; zero means that there is no limit
- Throws:
SQLException
- if a database access error occurs- See Also:
setMaxFieldSize(int)
-
setMaxFieldSize
Sets the maximum number of bytes that can be returned for a column value to the given number of bytes. This limit applies only toBINARY
,VARBINARY
,LONGVARBINARYBINARY
,CHAR
,VARCHAR
,LONGVARCHAR
,NCHAR
andNVARCHAR
columns. If the limit is exceeded, the excess data is silently discarded. For maximum portability, use values greater than 256.- Parameters:
max
- the new max column size limit in bytes; zero means unlimited- Throws:
SQLException
- if a database access error occurs- See Also:
getMaxFieldSize()
-
getMaxRows
Retrieves the maximum number of rows that thisRowSet
object can contain. If the limit is exceeded, the excess rows are silently dropped.- Returns:
- the current maximum number of rows that this
RowSet
object can contain; zero means unlimited - Throws:
SQLException
- if a database access error occurs- See Also:
setMaxRows(int)
-
setMaxRows
Sets the maximum number of rows that thisRowSet
object can contain to the specified number. If the limit is exceeded, the excess rows are silently dropped.- Parameters:
max
- the new maximum number of rows; zero means unlimited- Throws:
SQLException
- if a database access error occurs- See Also:
getMaxRows()
-
getEscapeProcessing
Retrieves whether escape processing is enabled for thisRowSet
object. If escape scanning is enabled, which is the default, the driver will do escape substitution before sending an SQL statement to the database.- Returns:
true
if escape processing is enabled;false
if it is disabled- Throws:
SQLException
- if a database access error occurs- See Also:
setEscapeProcessing(boolean)
-
setEscapeProcessing
Sets escape processing for thisRowSet
object on or off. If escape scanning is on (the default), the driver will do escape substitution before sending an SQL statement to the database.- Parameters:
enable
-true
to enable escape processing;false
to disable it- Throws:
SQLException
- if a database access error occurs- See Also:
getEscapeProcessing()
-
getQueryTimeout
Retrieves the maximum number of seconds the driver will wait for a statement to execute. If this limit is exceeded, anSQLException
is thrown.- Returns:
- the current query timeout limit in seconds; zero means unlimited
- Throws:
SQLException
- if a database access error occurs- See Also:
setQueryTimeout(int)
-
setQueryTimeout
Sets the maximum time the driver will wait for a statement to execute to the given number of seconds. If this limit is exceeded, anSQLException
is thrown.- Parameters:
seconds
- the new query timeout limit in seconds; zero means that there is no limit- Throws:
SQLException
- if a database access error occurs- See Also:
getQueryTimeout()
-
setType
Sets the type of thisRowSet
object to the given type. This method is used to change the type of a rowset, which is by default read-only and non-scrollable.- Parameters:
type
- one of theResultSet
constants specifying a type:ResultSet.TYPE_FORWARD_ONLY
,ResultSet.TYPE_SCROLL_INSENSITIVE
, orResultSet.TYPE_SCROLL_SENSITIVE
- Throws:
SQLException
- if a database access error occurs- See Also:
ResultSet.getType()
-
setConcurrency
Sets the concurrency of thisRowSet
object to the given concurrency level. This method is used to change the concurrency level of a rowset, which is by defaultResultSet.CONCUR_READ_ONLY
- Parameters:
concurrency
- one of theResultSet
constants specifying a concurrency level:ResultSet.CONCUR_READ_ONLY
orResultSet.CONCUR_UPDATABLE
- Throws:
SQLException
- if a database access error occurs- See Also:
ResultSet.getConcurrency()
-
setNull
Sets the designated parameter in thisRowSet
object's SQL command to SQLNULL
.Note: You must specify the parameter's SQL type.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...sqlType
- a SQL type code defined byjava.sql.Types
- Throws:
SQLException
- if a database access error occurs
-
setNull
Sets the designated parameter to SQLNULL
.Note: You must specify the parameter's SQL type.
- Parameters:
parameterName
- the name of the parametersqlType
- the SQL type code defined injava.sql.Types
- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
setNull
Sets the designated parameter in thisRowSet
object's SQL command to SQLNULL
. This version of the methodsetNull
should be used for SQL user-defined types (UDTs) andREF
type parameters. Examples of UDTs include:STRUCT
,DISTINCT
,JAVA_OBJECT
, and named array types.Note: To be portable, applications must give the SQL type code and the fully qualified SQL type name when specifying a NULL UDT or
REF
parameter. In the case of a UDT, the name is the type name of the parameter itself. For aREF
parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for UDT andREF
parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined orREF
type, the typeName parameter is ignored.- Parameters:
paramIndex
- the first parameter is 1, the second is 2, ...sqlType
- a value fromjava.sql.Types
typeName
- the fully qualified name of an SQL UDT or the type name of the SQL structured type being referenced by aREF
type; ignored if the parameter is not a UDT orREF
type- Throws:
SQLException
- if a database access error occurs
-
setNull
Sets the designated parameter to SQLNULL
. This version of the methodsetNull
should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it. Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.
- Parameters:
parameterName
- the name of the parametersqlType
- a value fromjava.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQLREF
value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
setBoolean
Sets the designated parameter in thisRowSet
object's command to the given Javaboolean
value. The driver converts this to an SQLBIT
value before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setBoolean
Sets the designated parameter to the given Javaboolean
value. The driver converts this to an SQLBIT
orBOOLEAN
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getBoolean(int)
-
setByte
Sets the designated parameter in thisRowSet
object's command to the given Javabyte
value. The driver converts this to an SQLTINYINT
value before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setByte
Sets the designated parameter to the given Javabyte
value. The driver converts this to an SQLTINYINT
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getByte(int)
-
setShort
Sets the designated parameter in thisRowSet
object's command to the given Javashort
value. The driver converts this to an SQLSMALLINT
value before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setShort
Sets the designated parameter to the given Javashort
value. The driver converts this to an SQLSMALLINT
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getShort(int)
-
setInt
Sets the designated parameter in thisRowSet
object's command to the given Javaint
value. The driver converts this to an SQLINTEGER
value before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setInt
Sets the designated parameter to the given Javaint
value. The driver converts this to an SQLINTEGER
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getInt(int)
-
setLong
Sets the designated parameter in thisRowSet
object's command to the given Javalong
value. The driver converts this to an SQLBIGINT
value before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setLong
Sets the designated parameter to the given Javalong
value. The driver converts this to an SQLBIGINT
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getLong(int)
-
setFloat
Sets the designated parameter in thisRowSet
object's command to the given Javafloat
value. The driver converts this to an SQLREAL
value before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setFloat
Sets the designated parameter to the given Javafloat
value. The driver converts this to an SQLFLOAT
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getFloat(int)
-
setDouble
Sets the designated parameter in thisRowSet
object's command to the given Javadouble
value. The driver converts this to an SQLDOUBLE
value before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setDouble
Sets the designated parameter to the given Javadouble
value. The driver converts this to an SQLDOUBLE
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getDouble(int)
-
setBigDecimal
Sets the designated parameter in thisRowSet
object's command to the givenjava.math.BigDecimal
value. The driver converts this to an SQLNUMERIC
value before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setBigDecimal
Sets the designated parameter to the givenjava.math.BigDecimal
value. The driver converts this to an SQLNUMERIC
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getBigDecimal(int, int)
-
setString
Sets the designated parameter in thisRowSet
object's command to the given JavaString
value. Before sending it to the database, the driver converts this to an SQLVARCHAR
orLONGVARCHAR
value, depending on the argument's size relative to the driver's limits onVARCHAR
values.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setString
Sets the designated parameter to the given JavaString
value. The driver converts this to an SQLVARCHAR
orLONGVARCHAR
value (depending on the argument's size relative to the driver's limits onVARCHAR
values) when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getString(int)
-
setBytes
Sets the designated parameter in thisRowSet
object's command to the given Java array ofbyte
values. Before sending it to the database, the driver converts this to an SQLVARBINARY
orLONGVARBINARY
value, depending on the argument's size relative to the driver's limits onVARBINARY
values.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setBytes
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARY
orLONGVARBINARY
(depending on the argument's size relative to the driver's limits onVARBINARY
values) when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getBytes(int)
-
setDate
Sets the designated parameter in thisRowSet
object's command to the givenjava.sql.Date
value. The driver converts this to an SQLDATE
value before sending it to the database, using the defaultjava.util.Calendar
to calculate the date.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setTime
Sets the designated parameter in thisRowSet
object's command to the givenjava.sql.Time
value. The driver converts this to an SQLTIME
value before sending it to the database, using the defaultjava.util.Calendar
to calculate it.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setTimestamp
Sets the designated parameter in thisRowSet
object's command to the givenjava.sql.Timestamp
value. The driver converts this to an SQLTIMESTAMP
value before sending it to the database, using the defaultjava.util.Calendar
to calculate it.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLTIMESTAMP
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getTimestamp(int)
-
setAsciiStream
Sets the designated parameter in thisRowSet
object's command to the givenjava.io.InputStream
value. It may be more practical to send a very large ASCII value via ajava.io.InputStream
rather than as aLONGVARCHAR
parameter. The driver will read the data from the stream as needed until it reaches end-of-file.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs
-
setAsciiStream
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterName
- the name of the parameterx
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
setBinaryStream
Sets the designated parameter in thisRowSet
object's command to the givenjava.io.InputStream
value. It may be more practical to send a very large binary value via ajava.io.InputStream
rather than as aLONGVARBINARY
parameter. The driver will read the data from the stream as needed until it reaches end-of-file.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs
-
setBinaryStream
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterName
- the name of the parameterx
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
setCharacterStream
Sets the designated parameter in thisRowSet
object's command to the givenjava.io.Reader
value. It may be more practical to send a very large UNICODE value via ajava.io.Reader
rather than as aLONGVARCHAR
parameter. The driver will read the data from the stream as needed until it reaches end-of-file.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- theReader
object that contains the UNICODE data to be setlength
- the number of characters in the stream- Throws:
SQLException
- if a database access error occurs
-
setCharacterStream
Sets the designated parameter to the givenReader
object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
- Parameters:
parameterName
- the name of the parameterreader
- thejava.io.Reader
object that contains the UNICODE data used as the designated parameterlength
- the number of characters in the stream- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-
setAsciiStream
Sets the designated parameter in thisRowSet
object's command to the given input stream. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStream
which takes a length parameter.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the Java input stream that contains the ASCII parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setAsciiStream
Sets the designated parameter to the given input stream. When a very large ASCII value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.InputStream
. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setAsciiStream
which takes a length parameter.- Parameters:
parameterName
- the name of the parameterx
- the Java input stream that contains the ASCII parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
Sets the designated parameter in thisRowSet
object's command to the given input stream. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStream
which takes a length parameter.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the java input stream which contains the binary parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setBinaryStream
Sets the designated parameter to the given input stream. When a very large binary value is input to aLONGVARBINARY
parameter, it may be more practical to send it via ajava.io.InputStream
object. The data will be read from the stream as needed until end-of-file is reached.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBinaryStream
which takes a length parameter.- Parameters:
parameterName
- the name of the parameterx
- the java input stream which contains the binary parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
Sets the designated parameter in thisRowSet
object's command to the givenReader
object. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStream
which takes a length parameter.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...reader
- thejava.io.Reader
object that contains the Unicode data- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setCharacterStream
Sets the designated parameter to the givenReader
object. When a very large UNICODE value is input to aLONGVARCHAR
parameter, it may be more practical to send it via ajava.io.Reader
object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setCharacterStream
which takes a length parameter.- Parameters:
parameterName
- the name of the parameterreader
- thejava.io.Reader
object that contains the Unicode data- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter in thisRowSet
object's command to aReader
object. TheReader
reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStream
which takes a length parameter.- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; if a database access error occurs; or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setObject
void setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength) throws SQLExceptionSets the designated parameter in thisRowSet
object's command with the given JavaObject
. For integral values, thejava.lang
equivalent objects should be used (for example, an instance of the classInteger
for anint
). If the second argument is anInputStream
then the stream must contain the number of bytes specified by scaleOrLength. If the second argument is aReader
then theReader
must contain the number of characters specified by scaleOrLength. If these conditions are not true the driver will generate aSQLException
when the prepared statement is executed.The given Java object will be converted to the targetSqlType before being sent to the database.
If the object is of a class implementing
SQLData
, the rowset should call the methodSQLData.writeSQL
to write the object to anSQLOutput
data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,NClob
,Struct
,java.net.URL
, orArray
, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database-specific abstract data types.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined injava.sql.Types
) to be sent to the database. The scale argument may further qualify this type.scaleOrLength
- forjava.sql.Types.DECIMAL
orjava.sql.Types.NUMERIC types
, this is the number of digits after the decimal point. For Java Object typesInputStream
andReader
, this is the length of the data in the stream orReader
. For all other types, this value will be ignored.- Throws:
SQLException
- if a database access error occurs- See Also:
Types
-
setObject
Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, thejava.lang
equivalent objects should be used.The given Java object will be converted to the given targetSqlType before being sent to the database. If the object has a custom mapping (is of a class implementing the interface
SQLData
), the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,NClob
,Struct
,java.net.URL
, orArray
, the driver should pass it to the database as a value of the corresponding SQL type.Note that this method may be used to pass database- specific abstract data types.
- Parameters:
parameterName
- the name of the parameterx
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.scale
- for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- iftargetSqlType
is aARRAY
,BLOB
,CLOB
,DATALINK
,JAVA_OBJECT
,NCHAR
,NCLOB
,NVARCHAR
,LONGNVARCHAR
,REF
,ROWID
,SQLXML
orSTRUCT
data type and the JDBC driver does not support this data type- Since:
- 1.4
- See Also:
Types
,ResultSet.getObject(int)
-
setObject
Sets the designated parameter in thisRowSet
object's command with a JavaObject
. For integral values, thejava.lang
equivalent objects should be used. This method is likesetObject
above, but the scale used is the scale of the second parameter. Scalar values have a scale of zero. Literal values have the scale present in the literal.Even though it is supported, it is not recommended that this method be called with floating point input values.
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined injava.sql.Types
) to be sent to the database- Throws:
SQLException
- if a database access error occurs
-
setObject
Sets the value of the designated parameter with the given object. This method is like the methodsetObject
above, except that it assumes a scale of zero.- Parameters:
parameterName
- the name of the parameterx
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- iftargetSqlType
is aARRAY
,BLOB
,CLOB
,DATALINK
,JAVA_OBJECT
,NCHAR
,NCLOB
,NVARCHAR
,LONGNVARCHAR
,REF
,ROWID
,SQLXML
orSTRUCT
data type and the JDBC driver does not support this data type- Since:
- 1.4
- See Also:
ResultSet.getObject(int)
-
setObject
Sets the value of the designated parameter with the given object. The second parameter must be of typeObject
; therefore, thejava.lang
equivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Object
types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.Note that this method may be used to pass database- specific abstract data types, by using a driver-specific Java type. If the object is of a class implementing the interface
SQLData
, the JDBC driver should call the methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,NClob
,Struct
,java.net.URL
, orArray
, the driver should pass it to the database as a value of the corresponding SQL type.This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.
- Parameters:
parameterName
- the name of the parameterx
- the object containing the input parameter value- Throws:
SQLException
- if a database access error occurs, this method is called on a closedCallableStatement
or if the givenObject
parameter is ambiguousSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getObject(int)
-
setObject
Sets the designated parameter in thisRowSet
object's command with a JavaObject
. For integral values, thejava.lang
equivalent objects should be used.The JDBC specification provides a standard mapping from Java Object types to SQL types. The driver will convert the given Java object to its standard SQL mapping before sending it to the database.
Note that this method may be used to pass database-specific abstract data types by using a driver-specific Java type. If the object is of a class implementing
SQLData
, the rowset should call the methodSQLData.writeSQL
to write the object to anSQLOutput
data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,NClob
,Struct
,java.net.URL
, orArray
, the driver should pass it to the database as a value of the corresponding SQL type.An exception is thrown if there is an ambiguity, for example, if the object is of a class implementing more than one of these interfaces.
- Parameters:
parameterIndex
- The first parameter is 1, the second is 2, ...x
- The object containing the input parameter value- Throws:
SQLException
- if a database access error occurs
-
setRef
Sets the designated parameter in thisRowSet
object's command with the givenRef
value. The driver will convert this to the appropriateREF(<structured-type>)
value.- Parameters:
i
- the first parameter is 1, the second is 2, ...x
- an object representing data of an SQLREF
type- Throws:
SQLException
- if a database access error occurs
-
setBlob
Sets the designated parameter in thisRowSet
object's command with the givenBlob
value. The driver will convert this to theBLOB
value that theBlob
object represents before sending it to the database.- Parameters:
i
- the first parameter is 1, the second is 2, ...x
- an object representing a BLOB- Throws:
SQLException
- if a database access error occurs
-
setBlob
Sets the designated parameter to aInputStream
object. TheInputStream
must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be sent to the server as aBLOB
. When thesetBinaryStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY
or aBLOB
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...inputStream
- An object that contains the data to set the parameter value to.length
- the number of bytes in the parameter data.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
, if parameterIndex does not correspond to a parameter marker in the SQL statement, if the length specified is less than zero or if the number of bytes in theInputStream
does not match the specified length.SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to aInputStream
object. This method differs from thesetBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be sent to the server as aBLOB
. When thesetBinaryStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY
or aBLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlob
which takes a length parameter.- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...inputStream
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
or if parameterIndex does not correspond to a parameter marker in the SQL statement,SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to aInputStream
object. TheInputStream
must contain the number of characters specified by length, otherwise aSQLException
will be generated when theCallableStatement
is executed. This method differs from thesetBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be sent to the server as aBLOB
. When thesetBinaryStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARBINARY
or aBLOB
- Parameters:
parameterName
- the name of the parameter to be set the second is 2, ...inputStream
- An object that contains the data to set the parameter value to.length
- the number of bytes in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement, or if the length specified is less than zero; if the number of bytes in theInputStream
does not match the specified length; if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to the givenjava.sql.Blob
object. The driver converts this to an SQLBLOB
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- aBlob
object that maps an SQLBLOB
value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setBlob
Sets the designated parameter to aInputStream
object. This method differs from thesetBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be sent to the server as aBLOB
. When thesetBinaryStream
method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARBINARY
or aBLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setBlob
which takes a length parameter.- Parameters:
parameterName
- the name of the parameterinputStream
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter in thisRowSet
object's command with the givenClob
value. The driver will convert this to theCLOB
value that theClob
object represents before sending it to the database.- Parameters:
i
- the first parameter is 1, the second is 2, ...x
- an object representing a CLOB- Throws:
SQLException
- if a database access error occurs
-
setClob
Sets the designated parameter to aReader
object. TheReader
must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetCharacterStream (int, Reader, int)
method because it informs the driver that the parameter value should be sent to the server as aCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHAR
or aCLOB
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
, if parameterIndex does not correspond to a parameter marker in the SQL statement, or if the length specified is less than zero.SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to aReader
object. This method differs from thesetCharacterStream (int, Reader)
method because it informs the driver that the parameter value should be sent to the server as aCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGVARCHAR
or aCLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClob
which takes a length parameter.- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if a database access error occurs, this method is called on a closedPreparedStatement
or if parameterIndex does not correspond to a parameter marker in the SQL statementSQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to aReader
object. TheReader
must contain the number of characters specified by length otherwise aSQLException
will be generated when theCallableStatement
is executed. This method differs from thesetCharacterStream (int, Reader, int)
method because it informs the driver that the parameter value should be sent to the server as aCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARCHAR
or aCLOB
- Parameters:
parameterName
- the name of the parameter to be setreader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to the givenjava.sql.Clob
object. The driver converts this to an SQLCLOB
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- aClob
object that maps an SQLCLOB
value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setClob
Sets the designated parameter to aReader
object. This method differs from thesetCharacterStream (int, Reader)
method because it informs the driver that the parameter value should be sent to the server as aCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGVARCHAR
or aCLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setClob
which takes a length parameter.- Parameters:
parameterName
- the name of the parameterreader
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setArray
Sets the designated parameter in thisRowSet
object's command with the givenArray
value. The driver will convert this to theARRAY
value that theArray
object represents before sending it to the database.- Parameters:
i
- the first parameter is 1, the second is 2, ...x
- an object representing an SQL array- Throws:
SQLException
- if a database access error occurs
-
setDate
Sets the designated parameter in thisRowSet
object's command with the givenjava.sql.Date
value. The driver will convert this to an SQLDATE
value, using the givenjava.util.Calendar
object to calculate the date.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- thejava.util.Calendar
object to use for calculating the date- Throws:
SQLException
- if a database access error occurs
-
setDate
Sets the designated parameter to the givenjava.sql.Date
value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQLDATE
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getDate(int)
-
setDate
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLDATE
value, which the driver then sends to the database. With a aCalendar
object, the driver can calculate the date taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the date- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getDate(int)
-
setTime
Sets the designated parameter in thisRowSet
object's command with the givenjava.sql.Time
value. The driver will convert this to an SQLTIME
value, using the givenjava.util.Calendar
object to calculate it, before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- thejava.util.Calendar
object to use for calculating the time- Throws:
SQLException
- if a database access error occurs
-
setTime
Sets the designated parameter to the givenjava.sql.Time
value. The driver converts this to an SQLTIME
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getTime(int)
-
setTime
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIME
value, which the driver then sends to the database. With a aCalendar
object, the driver can calculate the time taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the time- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getTime(int)
-
setTimestamp
Sets the designated parameter in thisRowSet
object's command with the givenjava.sql.Timestamp
value. The driver will convert this to an SQLTIMESTAMP
value, using the givenjava.util.Calendar
object to calculate it, before sending it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter valuecal
- thejava.util.Calendar
object to use for calculating the timestamp- Throws:
SQLException
- if a database access error occurs
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIMESTAMP
value, which the driver then sends to the database. With a aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone. If noCalendar
object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the timestamp- Throws:
SQLException
- if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
- See Also:
ResultSet.getTimestamp(int)
-
clearParameters
Clears the parameters set for thisRowSet
object's command.In general, parameter values remain in force for repeated use of a
RowSet
object. Setting a parameter value automatically clears its previous value. However, in some cases it is useful to immediately release the resources used by the current parameter values, which can be done by calling the methodclearParameters
.- Throws:
SQLException
- if a database access error occurs
-
execute
Fills thisRowSet
object with data.The
execute
method may use the following properties to create a connection for reading data: url, data source name, user name, password, transaction isolation, and type map. Theexecute
method may use the following properties to create a statement to execute a command: command, read only, maximum field size, maximum rows, escape processing, and query timeout.If the required properties have not been set, an exception is thrown. If this method is successful, the current contents of the rowset are discarded and the rowset's metadata is also (re)set. If there are outstanding updates, they are ignored.
If this
RowSet
object does not maintain a continuous connection with its source of data, it may use aReader
(aRowSetReader
object) to fill itself with data. In this case, aReader
will have been registered with thisRowSet
object, and the methodexecute
will call on theReader
'sreadData
method as part of its implementation.- Throws:
SQLException
- if a database access error occurs or any of the properties necessary for making a connection and creating a statement have not been set
-
addRowSetListener
Registers the given listener so that it will be notified of events that occur on thisRowSet
object.- Parameters:
listener
- a component that has implemented theRowSetListener
interface and wants to be notified when events occur on thisRowSet
object- See Also:
removeRowSetListener(javax.sql.RowSetListener)
-
removeRowSetListener
Removes the specified listener from the list of components that will be notified when an event occurs on thisRowSet
object.- Parameters:
listener
- a component that has been registered as a listener for thisRowSet
object- See Also:
addRowSetListener(javax.sql.RowSetListener)
-
setSQLXML
Sets the designated parameter to the givenjava.sql.SQLXML
object. The driver converts this to an SQLXML
value when it sends it to the database.- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...xmlObject
- aSQLXML
object that maps an SQLXML
value- Throws:
SQLException
- if a database access error occurs, this method is called on a closed result set, thejava.xml.transform.Result
,Writer
orOutputStream
has not been closed for theSQLXML
object or if there is an error processing the XML value. ThegetCause
method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML.- Since:
- 1.6
-
setSQLXML
Sets the designated parameter to the givenjava.sql.SQLXML
object. The driver converts this to anSQL XML
value when it sends it to the database.- Parameters:
parameterName
- the name of the parameterxmlObject
- aSQLXML
object that maps anSQL XML
value- Throws:
SQLException
- if a database access error occurs, this method is called on a closed result set, thejava.xml.transform.Result
,Writer
orOutputStream
has not been closed for theSQLXML
object or if there is an error processing the XML value. ThegetCause
method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML.- Since:
- 1.6
-
setRowId
Sets the designated parameter to the givenjava.sql.RowId
object. The driver converts this to a SQLROWID
value when it sends it to the database- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
setRowId
Sets the designated parameter to the givenjava.sql.RowId
object. The driver converts this to a SQLROWID
when it sends it to the database.- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.6
-
setNString
Sets the designated parameter to the givenString
object. The driver converts this to a SQLNCHAR
orNVARCHAR
orLONGNVARCHAR
value (depending on the argument's size relative to the driver's limits onNVARCHAR
values) when it sends it to the database.- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs- Since:
- 1.6
-
setNString
Sets the designated parameter to the givenString
object. The driver converts this to a SQLNCHAR
orNVARCHAR
orLONGNVARCHAR
- Parameters:
parameterName
- the name of the column to be setvalue
- the parameter value- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReader
object. TheReader
reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter valuelength
- the number of characters in the parameter data.- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReader
object. TheReader
reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.- Parameters:
parameterName
- the name of the column to be setvalue
- the parameter valuelength
- the number of characters in the parameter data.- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs- Since:
- 1.6
-
setNCharacterStream
Sets the designated parameter to aReader
object. TheReader
reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNCharacterStream
which takes a length parameter.- Parameters:
parameterName
- the name of the parametervalue
- the parameter value- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; if a database access error occurs; or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to ajava.sql.NClob
object. The object implements thejava.sql.NClob
interface. ThisNClob
object maps to a SQLNCLOB
.- Parameters:
parameterName
- the name of the column to be setvalue
- the parameter value- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; or if a database access error occurs- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReader
object. TheReader
must contain the number of characters specified by length otherwise aSQLException
will be generated when theCallableStatement
is executed. This method differs from thesetCharacterStream (int, Reader, int)
method because it informs the driver that the parameter value should be sent to the server as aNCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGNVARCHAR
or aNCLOB
- Parameters:
parameterName
- the name of the parameter to be setreader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReader
object. This method differs from thesetCharacterStream (int, Reader)
method because it informs the driver that the parameter value should be sent to the server as aNCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as aLONGNVARCHAR
or aNCLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClob
which takes a length parameter.- Parameters:
parameterName
- the name of the parameterreader
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedCallableStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReader
object. TheReader
must contain the number of characters specified by length otherwise aSQLException
will be generated when thePreparedStatement
is executed. This method differs from thesetCharacterStream (int, Reader, int)
method because it informs the driver that the parameter value should be sent to the server as aNCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHAR
or aNCLOB
- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.length
- the number of characters in the parameter data.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setNClob
Sets the designated parameter to ajava.sql.NClob
object. The driver converts this to a SQLNCLOB
value when it sends it to the database.- Parameters:
parameterIndex
- of the first parameter is 1, the second is 2, ...value
- the parameter value- Throws:
SQLException
- if the driver does not support national character sets; if the driver can detect that a data conversion error could occur ; or if a database access error occurs- Since:
- 1.6
-
setNClob
Sets the designated parameter to aReader
object. This method differs from thesetCharacterStream (int, Reader)
method because it informs the driver that the parameter value should be sent to the server as aNCLOB
. When thesetCharacterStream
method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as aLONGNVARCHAR
or aNCLOB
Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of
setNClob
which takes a length parameter.- Parameters:
parameterIndex
- index of the first parameter is 1, the second is 2, ...reader
- An object that contains the data to set the parameter value to.- Throws:
SQLException
- if parameterIndex does not correspond to a parameter marker in the SQL statement; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.6
-
setURL
Sets the designated parameter to the givenjava.net.URL
value. The driver converts this to an SQLDATALINK
value when it sends it to the database.- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, ...x
- thejava.net.URL
object to be set- Throws:
SQLException
- if a database access error occurs or this method is called on a closedPreparedStatement
SQLFeatureNotSupportedException
- if the JDBC driver does not support this method- Since:
- 1.4
-