File	Doc	Category	Size	Date	Package
BaseRowSet.java	API Doc	Java SE 6 API	215394	Tue Jun 10 00:26:32 BST 2008	javax.sql.rowset

BaseRowSet

• java.lang.Object

crs.setCommand("SELECT FIRST_NAME, LAST_NAME, ADDRESS FROM CUSTOMERS" +
"WHERE CREDIT_LIMIT > ? AND REGION = ?");

crs.setInt(1, 5000);
crs.setString(2, "West");

"SELECT FIRST_NAME, LAST_NAME, ADDRESS FROM CUSTOMERS" +
"WHERE CREDIT_LIMIT > 5000 AND REGION = 'West'"

crs.setMaxRows(500);

Fields Summary
public static final int	UNICODE_STREAM_PARAM A constant indicating to a RowSetReaderImpl object that a given parameter is a Unicode stream. This RowSetReaderImpl object is provided as an extension of the SyncProvider abstract class defined in the SyncFactory static factory SPI mechanism.
public static final int	BINARY_STREAM_PARAM A constant indicating to a RowSetReaderImpl object that a given parameter is a binary stream. A RowSetReaderImpl object is provided as an extension of the SyncProvider abstract class defined in the SyncFactory static factory SPI mechanism.
public static final int	ASCII_STREAM_PARAM A constant indicating to a RowSetReaderImpl object that a given parameter is an ASCII stream. A RowSetReaderImpl object is provided as an extension of the SyncProvider abstract class defined in the SyncFactory static factory SPI mechanism.
protected InputStream	binaryStream The InputStream object that will be returned by the method getBinaryStream, which is specified in the ResultSet interface.
protected InputStream	unicodeStream The InputStream object that will be returned by the method getUnicodeStream, which is specified in the ResultSet interface.
protected InputStream	asciiStream The InputStream object that will be returned by the method getAsciiStream, which is specified in the ResultSet interface.
protected Reader	charStream The Reader object that will be returned by the method getCharacterStream, which is specified in the ResultSet interface.
private String	command The query that will be sent to the DBMS for execution when the method execute is called.
private String	URL The JDBC URL the reader, writer, or both supply to the method DriverManager.getConnection when the DriverManager is used to get a connection. The JDBC URL identifies the driver to be used to make the conndection. This URL can be found in the documentation supplied by the driver vendor.
private String	dataSource The logical name of the data source that the reader/writer should use in order to retrieve a DataSource object from a Java Directory and Naming Interface (JNDI) naming service.
private transient String	username The user name the reader, writer, or both supply to the method DriverManager.getConnection when the DriverManager is used to get a connection.
private transient String	password The password the reader, writer, or both supply to the method DriverManager.getConnection when the DriverManager is used to get a connection.
private int	rowSetType A constant indicating the type of this JDBC RowSet object. It must be one of the following ResultSet constants: TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, or TYPE_SCROLL_SENSITIVE.
private boolean	showDeleted A boolean indicating whether deleted rows are visible in this JDBC RowSet object .
private int	queryTimeout The maximum number of seconds the driver will wait for a command to execute. This limit applies while this JDBC RowSet object is connected to its data source, that is, while it is populating itself with data and while it is writing data back to the data source.
private int	maxRows The maximum number of rows the reader should read.
private int	maxFieldSize The maximum field size the reader should read.
private int	concurrency A constant indicating the concurrency of this JDBC RowSet object. It must be one of the following ResultSet constants: CONCUR_READ_ONLY or CONCUR_UPDATABLE.
private boolean	readOnly A boolean indicating whether this JDBC RowSet object is read-only. true indicates that it is read-only; false that it is writable.
private boolean	escapeProcessing A boolean indicating whether the reader for this JDBC RowSet object should perform escape processing. true means that escape processing is turned on; false that it is not. The default is true.
private int	isolation A constant indicating the isolation level of the connection for this JDBC RowSet object . It must be one of the following Connection constants: TRANSACTION_NONE, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_READ_COMMITTED, TRANSACTION_REPEATABLE_READ or TRANSACTION_SERIALIZABLE.
private int	fetchDir A constant used as a hint to the driver that indicates the direction in which data from this JDBC RowSet object is going to be fetched. The following ResultSet constants are possible values: FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN. Unused at this time.
private int	fetchSize A hint to the driver that indicates the expected number of rows in this JDBC RowSet object . Unused at this time.
private Map	map The java.util.Map object that contains entries mapping SQL type names to classes in the Java programming language for the custom mapping of user-defined types.
private Vector	listeners A Vector object that holds the list of listeners that have registered with this RowSet object.
private Hashtable	params A Vector object that holds the parameters set for this RowSet object's current command.
static final long	serialVersionUID

Constructors Summary
public BaseRowSet() Constructs a new BaseRowSet object initialized with a default Vector object for its listeners field. The other default values with which it is initialized are listed in Section 6.0 of the class comment for this class. // could be transient? // allocate the listeners collection listeners = new Vector();

Methods Summary
public void	addRowSetListener(javax.sql.RowSetListener listener) The listener will be notified whenever an event occurs on this RowSet object. A listener might, for example, be a table or graph that needs to be updated in order to accurately reflect the current state of the RowSet object. Note: if the RowSetListener object is null, this method silently discards the null value and does not add a null reference to the set of listeners. Note: if the listener is already set, and the new RowSetListerner instance is added to the set of listeners already registered to receive event notifications from this RowSet. param listener an object that has implemented the javax.sql.RowSetListener interface and wants to be notified of any events that occur on this RowSet object; May be null. see #removeRowSetListener listeners.add(listener);
private void	checkParamIndex(int idx) Checks the given index to see whether it is less than 1 and throws an SQLException object if it is. This method is called by many methods internally; it is never called by an application directly. param idx an int indicating which parameter is to be checked; the first parameter is 1 throws SQLException if the parameter is less than 1 if ((idx < 1)) { throw new SQLException("Invalid Parameter Index"); }
private void	checkforRowSetInterface() Determine if instance of this class extends the RowSet interface. if ((this instanceof javax.sql.RowSet) == false) { throw new SQLException("The class extending abstract class BaseRowSet " + "must implement javax.sql.RowSet or one of it's sub-interfaces."); }
public void	clearParameters() Clears all of the current parameter values in this RowSet object's internal representation of the parameters to be set in this RowSet object's command when it is executed. In general, parameter values remain in force for repeated use in this RowSet object's command. Setting a parameter value with the setter methods automatically clears the value of the designated parameter and replaces it with the new specified value. This method is called internally by the setCommand method to clear all of the parameters set for the previous command. Furthermore, this method differs from the initParams method in that it maintains the schema of the RowSet object. throws SQLException if an error occurs clearing the parameters params.clear();
public java.lang.String	getCommand() Retrieves the SQL query that is the command for this RowSet object. The command property contains the query that will be executed to populate this RowSet object. The SQL query returned by this method is used by RowSet methods such as execute and populate, which may be implemented by any class that extends the BaseRowSet abstract class and implements one or more of the standard JSR-114 RowSet interfaces. The command is used by the RowSet object's reader to obtain a ResultSet object. The reader then reads the data from the ResultSet object and uses it to to populate this RowSet object. The default value for the command property is null. return the String that is the value for this RowSet object's command property; may be null see #setCommand return command;
public int	getConcurrency() Returns the concurrency for this RowSet object. The default is CONCUR_UPDATABLE for both connected and disconnected RowSet objects. An application can call the method setConcurrency at any time to change a RowSet object's concurrency. return the concurrency type for this RowSet object, which must be one of the following: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE throws SQLException if an error occurs getting the concurrency of this RowSet object see #setConcurrency see #isReadOnly return concurrency;
public java.lang.String	getDataSourceName() Returns the logical name that when supplied to a naming service that uses the Java Naming and Directory Interface (JNDI) API, will retrieve a javax.sql.DataSource object. This DataSource object can be used to establish a connection to the data source that it represents. Users should set either the url or the data source name property. The driver will use the property set most recently to establish a connection. return a String object that identifies the DataSource object to be used for making a connection; if no logical name has been set, null is returned. see #setDataSourceName return dataSource;
public boolean	getEscapeProcessing() Ascertains whether escape processing is enabled for this RowSet object. return true if escape processing is turned on; false otherwise throws SQLException if an error occurs determining if escape processing is enabled or not or if the internal escape processing trigger has not been enabled return escapeProcessing;
public int	getFetchDirection() Retrieves this RowSet object's current setting for the fetch direction. The default type is ResultSet.FETCH_FORWARD return one of ResultSet.FETCH_FORWARD, ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN throws SQLException if an error occurs in determining the current fetch direction for fetching rows see #setFetchDirection //Added the following code to throw a //SQL Exception if the fetchDir is not //set properly.Bug id:4914155 // This checking is not necessary! /* if((fetchDir != ResultSet.FETCH_FORWARD) && (fetchDir != ResultSet.FETCH_REVERSE) && (fetchDir != ResultSet.FETCH_UNKNOWN)) { throw new SQLException("Fetch Direction Invalid"); } */ return (fetchDir);
public int	getFetchSize() Returns the fetch size for this RowSet object. The default value is zero. return the number of rows suggested as the fetch size when this RowSet object needs more rows from the database throws SQLException if an error occurs determining the number of rows in the current fetch size see #setFetchSize return fetchSize;
public int	getMaxFieldSize() Retrieves the maximum number of bytes that can be used for a column value in this RowSet object. This limit applies only to columns that hold values of the following types: BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR. If the limit is exceeded, the excess data is silently discarded. return an int indicating the current maximum column size limit; zero means that there is no limit throws SQLException if an error occurs internally determining the maximum limit of the column size return maxFieldSize;
public int	getMaxRows() Retrieves the maximum number of rows that this RowSet object may contain. If this limit is exceeded, the excess rows are silently dropped. return an int indicating the current maximum number of rows; zero means that there is no limit throws SQLException if an error occurs internally determining the maximum limit of rows that a Rowset object can contain return maxRows;
public java.lang.Object[]	getParams() Retrieves an array containing the parameter values (both Objects and primitives) that have been set for this RowSet object's command and throws an SQLException object if all parameters have not been set. Before the command is sent to the DBMS to be executed, these parameters will be substituted for placeholder parameters in the PreparedStatement object that is the command for a RowSet implementation extending the BaseRowSet class. Each element in the array that is returned is an Object instance that contains the values of the parameters supplied to a setter method. The order of the elements is determined by the value supplied for parameterIndex. If the setter method takes only the parameter index and the value to be set (possibly null), the array element will contain the value to be set (which will be expressed as an Object). If there are additional parameters, the array element will itself be an array containing the value to be set plus any additional parameter values supplied to the setter method. If the method sets a stream, the array element includes the type of stream being supplied to the method. These additional parameters are for the use of the driver or the DBMS and may or may not be used. NOTE: Stored parameter values of types Array, Blob, Clob and Ref are returned as SerialArray, SerialBlob, SerialClob and SerialRef respectively. return an array of Object instances that includes the parameter values that may be set in this RowSet object's command; an empty array if no parameters have been set throws SQLException if an error occurs retrieveing the object array of parameters of this RowSet object or if not all parameters have been set if (params == null) { initParams(); Object [] paramsArray = new Object[params.size()]; return paramsArray; } else { // The parameters may be set in random order // but all must be set, check to verify all // have been set till the last parameter // else throw exception. Object[] paramsArray = new Object[params.size()]; for (int i = 0; i < params.size(); i++) { paramsArray[i] = params.get(new Integer(i)); if (paramsArray[i] == null) { throw new SQLException("missing parameter: " + (i + 1)); } //end if } //end for return paramsArray; } //end if
public java.lang.String	getPassword() Returns the password used to create a database connection for this RowSet object. Because the password property is not serialized, it is set at run time before calling the method execute. The default value is null return the String object that represents the password that must be supplied to the database to create a connection see #setPassword return password;
public int	getQueryTimeout() Retrieves the maximum number of seconds the driver will wait for a query to execute. If the limit is exceeded, an SQLException is thrown. return the current query timeout limit in seconds; zero means that there is no limit throws SQLException if an error occurs in determining the query time-out value return queryTimeout;
public boolean	getShowDeleted() Retrieves a boolean indicating whether rows marked for deletion appear in the set of current rows. The default value is false. Note: Allowing deleted rows to remain visible complicates the behavior of some of the methods. However, most RowSet object users can simply ignore this extra detail because only sophisticated applications will likely want to take advantage of this feature. return true if deleted rows are visible; false otherwise throws SQLException if an error occurs determining if deleted rows are visible or not see #setShowDeleted return showDeleted;
public int	getTransactionIsolation() Returns the transaction isolation property for this RowSet object's connection. This property represents the transaction isolation level requested for use in transactions. For RowSet implementations such as the CachedRowSet that operate in a disconnected environment, the SyncProvider object offers complementary locking and data integrity options. The options described below are pertinent only to connected RowSet objects (JdbcRowSet objects). return one of the following constants: Connection.TRANSACTION_NONE, Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE see javax.sql.rowset.spi.SyncFactory see javax.sql.rowset.spi.SyncProvider see #setTransactionIsolation return isolation;
public int	getType() Returns the type of this RowSet object. The type is initially determined by the statement that created the RowSet object. The RowSet object can call the method setType at any time to change its type. The default is TYPE_SCROLL_INSENSITIVE. return the type of this JDBC RowSet object, which must be one of the following: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE throws SQLException if an error occurs getting the type of of this RowSet object see #setType return rowSetType;
public java.util.Map	getTypeMap() Retrieves the type map associated with the Connection object for this RowSet object. Drivers that support the JDBC 3.0 API will create Connection objects with an associated type map. This type map, which is initially empty, can contain one or more fully-qualified SQL names and Class objects indicating the class to which the named SQL value will be mapped. The type mapping specified in the connection's type map is used for custom type mapping when no other type map supersedes it. If a type map is explicitly supplied to a method that can perform custom mapping, that type map supersedes the connection's type map. return the java.util.Map object that is the type map for this RowSet object's connection return map;
public java.lang.String	getUrl() Retrieves the JDBC URL that this RowSet object's javax.sql.Reader object uses to make a connection with a relational database using a JDBC technology-enabled driver. The Url property will be null if the underlying data source is a non-SQL data source, such as a spreadsheet or an XML data source. return a String object that contains the JDBC URL used to establish the connection for this RowSet object; may be null (default value) if not set throws SQLException if an error occurs retrieving the URL value see #setUrl return URL;
public java.lang.String	getUsername() Returns the user name used to create a database connection. Because it is not serialized, the username property is set at runtime before calling the method execute. return the String object containing the user name that is supplied to the data source to create a connection; may be null (default value) if not set see #setUsername return username;
protected void	initParams() Performs the necessary internal configurations and initializations to allow any JDBC RowSet implementation to start using the standard facilities provided by a BaseRowSet instance. This method should be called after the RowSet object has been instantiated to correctly initialize all parameters. This method should never be called by an application, but is called from with a RowSet implementation extending this class. params = new Hashtable();
public boolean	isReadOnly() Returns a boolean indicating whether this RowSet object is read-only. Any attempts to update a read-only RowSet object will result in an SQLException being thrown. By default, rowsets are updatable if updates are possible. return true if this RowSet object cannot be updated; false otherwise see #setConcurrency see #setReadOnly return readOnly;
protected void	notifyCursorMoved() Notifies all of the listeners registered with this RowSet object that its cursor has moved. When an application calls a method to move the cursor, that method moves the cursor and then calls this method internally. An application should never invoke this method directly. throws SQLException if the class extending the BaseRowSet abstract class does not implement the RowSet interface or one of it's sub-interfaces. checkforRowSetInterface(); if (listeners.isEmpty() == false) { RowSetEvent event = new RowSetEvent((RowSet)this); for (Iterator i = listeners.iterator(); i.hasNext(); ) { ((RowSetListener)i.next()).cursorMoved(event); } }
protected void	notifyRowChanged() Notifies all of the listeners registered with this RowSet object that one of its rows has changed. When an application calls a method that changes a row, such as the CachedRowSet methods insertRow, updateRow, or deleteRow, that method calls notifyRowChanged internally. An application should never invoke this method directly. throws SQLException if the class extending the BaseRowSet abstract class does not implement the RowSet interface or one of it's sub-interfaces. checkforRowSetInterface(); if (listeners.isEmpty() == false) { RowSetEvent event = new RowSetEvent((RowSet)this); for (Iterator i = listeners.iterator(); i.hasNext(); ) { ((RowSetListener)i.next()).rowChanged(event); } }
protected void	notifyRowSetChanged() Notifies all of the listeners registered with this RowSet object that its entire contents have changed. When an application calls methods that change the entire contents of the RowSet object, such as the CachedRowSet methods execute, populate, restoreOriginal, or release, that method calls notifyRowSetChanged internally (either directly or indirectly). An application should never invoke this method directly. throws SQLException if the class extending the BaseRowSet abstract class does not implement the RowSet interface or one of it's sub-interfaces. checkforRowSetInterface(); if (listeners.isEmpty() == false) { RowSetEvent event = new RowSetEvent((RowSet)this); for (Iterator i = listeners.iterator(); i.hasNext(); ) { ((RowSetListener)i.next()).rowSetChanged(event); } }
public void	removeRowSetListener(javax.sql.RowSetListener listener) Removes the designated object from this RowSet object's list of listeners. If the given argument is not a registered listener, this method does nothing. Note: if the RowSetListener object is null, this method silently discards the null value. param listener a RowSetListener object that is on the list of listeners for this RowSet object see #addRowSetListener listeners.remove(listener);
public void	setArray(int parameterIndex, java.sql.Array array) Sets the designated parameter to an Array object in the Java programming language. The driver converts this to an SQL ARRAY value when it sends it to the database. Internally, the Array is represented as a SerialArray to ensure serializability. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. Note: JdbcRowSet does not require the populate method as it is undefined in this class. After this method has been called, a call to the method getParams will return an object array of the current command parameters, which will include the Array object set for placeholder parameter number parameterIndex. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param array an Array object representing an SQL ARRAY value; cannot be null. The Array object passed to this method must return a non-null Object for all getArray() method calls. A null value will cause a SQLException to be thrown. throws SQLException if an error occurs; the parameter index is out of bounds or the ARRAY is null see #getParams see javax.sql.rowset.serial.SerialArray checkParamIndex(parameterIndex); if (params == null){ throw new SQLException("Set initParams() before setArray"); } params.put(new Integer(parameterIndex - 1), new SerialArray(array));
public void	setAsciiStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter to the given java.io.InputStream object, which will have the specified number of bytes. The contents of the stream will be read and sent to the database. This method throws an SQLException object if the number of bytes read and sent to the database is not equal to length. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream object. A JDBC technology-enabled driver will read the data from the stream as needed until it reaches end-of-file. The driver will do any necessary conversion from ASCII to the database CHAR format. Note: This stream object can be either a standard Java stream object or your own subclass that implements the standard interface. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. Note: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after setAsciiStream has been called will return an array containing the parameter values that have been set. The element in the array that represents the values set with this method will itself be an array. The first element of that array is the given java.io.InputStream object. The second element is the value set for length. The third element is an internal BaseRowSet constant specifying that the stream passed to this method is an ASCII stream. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the input stream being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the Java input stream that contains the ASCII parameter value param length the number of bytes in the stream. This is the number of bytes the driver will send to the DBMS; lengths of 0 or less are are undefined but will cause an invalid length exception to be thrown in the underlying JDBC driver. throws SQLException if an error occurs, the parameter index is out of bounds, or when connected to a data source, the number of bytes the driver reads and sends to the database is not equal to the number of bytes specified in length see #getParams Object asciiStream[]; checkParamIndex(parameterIndex); asciiStream = new Object[3]; asciiStream[0] = x; asciiStream[1] = new Integer(length); asciiStream[2] = new Integer(ASCII_STREAM_PARAM); if(params == null){ throw new SQLException("Set initParams() before setAsciiStream"); } params.put(new Integer(parameterIndex - 1), asciiStream);
public void	setAsciiStream(int parameterIndex, java.io.InputStream x) Sets the designated parameter in this RowSet object's command to the given input stream. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.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. param parameterIndex the first parameter is 1, the second is 2, ... param x the Java input stream that contains the ASCII parameter value exception SQLException if a database access error occurs or this method is called on a closed PreparedStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length) 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 a LONGVARCHAR parameter, it may be more practical to send it via a java.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. param parameterName the name of the parameter param x the Java input stream that contains the ASCII parameter value param length the number of bytes in the stream exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setAsciiStream(java.lang.String parameterName, java.io.InputStream x) Sets the designated parameter to the given input stream. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.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. param parameterName the name of the parameter param x the Java input stream that contains the ASCII parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBigDecimal(int parameterIndex, java.math.BigDecimal x) Sets the designated parameter to the given java.lang.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. Note: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setBigDecimal"); } params.put(new Integer(parameterIndex - 1), x);
public void	setBigDecimal(java.lang.String parameterName, java.math.BigDecimal x) Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getBigDecimal since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBinaryStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter to the given java.io.InputStream object, which will have the specified number of bytes. The contents of the stream will be read and sent to the database. This method throws an SQLException object if the number of bytes read and sent to the database is not equal to length. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. A JDBC technology-enabled driver will read the data from the stream as needed until it reaches end-of-file. Note: This stream object can be either a standard Java stream object or your own subclass that implements the standard interface. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after setBinaryStream has been called will return an array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is the given java.io.InputStream object. The second element is the value set for length. The third element is an internal BaseRowSet constant specifying that the stream passed to this method is a binary stream. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the input stream being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the input stream that contains the binary value to be set param length the number of bytes in the stream; lengths of 0 or less are are undefined but will cause an invalid length exception to be thrown in the underlying JDBC driver. throws SQLException if an error occurs, the parameter index is out of bounds, or when connected to a data source, the number of bytes the driver reads and sends to the database is not equal to the number of bytes specified in length see #getParams Object binaryStream[]; checkParamIndex(parameterIndex); binaryStream = new Object[3]; binaryStream[0] = x; binaryStream[1] = new Integer(length); binaryStream[2] = new Integer(BINARY_STREAM_PARAM); if(params == null){ throw new SQLException("Set initParams() before setBinaryStream"); } params.put(new Integer(parameterIndex - 1), binaryStream);
public void	setBinaryStream(int parameterIndex, java.io.InputStream x) Sets the designated parameter in this RowSet object's command to the given input stream. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.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. param parameterIndex the first parameter is 1, the second is 2, ... param x the java input stream which contains the binary parameter value exception SQLException if a database access error occurs or this method is called on a closed PreparedStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length) 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 a LONGVARBINARY parameter, it may be more practical to send it via a java.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. param parameterName the name of the parameter param x the java input stream which contains the binary parameter value param length the number of bytes in the stream exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBinaryStream(java.lang.String parameterName, java.io.InputStream x) Sets the designated parameter to the given input stream. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.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. param parameterName the name of the parameter param x the java input stream which contains the binary parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBlob(int parameterIndex, java.io.InputStream inputStream, long length) Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB param parameterIndex index of the first parameter is 1, the second is 2, ... param inputStream An object that contains the data to set the parameter value to. param length the number of bytes in the parameter data. throws SQLException if a database access error occurs, this method is called on a closed PreparedStatement, 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 the inputstream does not match the specfied length. throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBlob(int parameterIndex, java.io.InputStream inputStream) Sets the designated parameter to a InputStream object. This method differs from the setBinaryStream (int, InputStream) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB 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. param parameterIndex index of the first parameter is 1, the second is 2, ... param 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 closed PreparedStatement or if parameterIndex does not correspond to a parameter marker in the SQL statement, throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBlob(java.lang.String parameterName, java.io.InputStream inputStream, long length) Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length, otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB param parameterName the name of the parameter to be set the second is 2, ... param inputStream An object that contains the data to set the parameter value to. param 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 the inputstream does not match the specfied length; if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBlob(java.lang.String parameterName, java.sql.Blob x) Sets the designated parameter to the given java.sql.Blob object. The driver converts this to an SQL BLOB value when it sends it to the database. param parameterName the name of the parameter param x a Blob object that maps an SQL BLOB value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBlob(java.lang.String parameterName, java.io.InputStream inputStream) Sets the designated parameter to a InputStream object. This method differs from the setBinaryStream (int, InputStream) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARBINARY or a BLOB 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. param parameterName the name of the parameter param inputStream 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 closed CallableStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBlob(int parameterIndex, java.sql.Blob x) Sets the designated parameter to the given Blob object in the Java programming language. The driver converts this to an SQL BLOB value when it sends it to the database. Internally, the Blob is represented as a SerialBlob to ensure serializability. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. After this method has been called, a call to the method getParams will return an object array of the current command parameters, which will include the Blob object set for placeholder parameter number parameterIndex. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x a Blob object representing an SQL BLOB value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams see javax.sql.rowset.serial.SerialBlob checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setBlob"); } params.put(new Integer(parameterIndex - 1), new SerialBlob(x));
public void	setBoolean(int parameterIndex, boolean x) Sets the designated parameter to the given boolean in the Java programming language. The driver converts this to an SQL BIT value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute, populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setNull"); } params.put(new Integer(parameterIndex - 1), new Boolean(x));
public void	setBoolean(java.lang.String parameterName, boolean x) Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT or BOOLEAN value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement see #getBoolean exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setByte(int parameterIndex, byte x) Sets the designated parameter to the given byte in the Java programming language. The driver converts this to an SQL TINYINT value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setByte"); } params.put(new Integer(parameterIndex - 1), new Byte(x));
public void	setByte(java.lang.String parameterName, byte x) Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getByte since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setBytes(int parameterIndex, byte[] x) Sets the designated parameter to the given array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY value (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setBytes"); } params.put(new Integer(parameterIndex - 1), x);
public void	setBytes(java.lang.String parameterName, byte[] x) Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getBytes since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setCharacterStream(int parameterIndex, java.io.Reader reader, int length) Sets the designated parameter to the given java.io.Reader object, which will have the specified number of characters. The contents of the reader will be read and sent to the database. This method throws an SQLException if the number of bytes read and sent to the database is not equal to length. When a very large Unicode value is input to a LONGVARCHAR parameter, it may be more practical to send it via a Reader object. A JDBC technology-enabled driver will read the data from the stream as needed until it reaches end-of-file. The driver will do any necessary conversion from Unicode to the database CHAR format. The byte format of the Unicode stream must be Java UTF-8, as defined in the Java Virtual Machine Specification. Note: This stream object can be either a standard Java stream object or your own subclass that implements the standard interface. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after setCharacterStream has been called will return an array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is the given java.io.Reader object. The second element is the value set for length. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the reader being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param reader the Reader object that contains the Unicode data param length the number of characters in the stream; lengths of 0 or less are undefined but will cause an invalid length exception to be thrown in the underlying JDBC driver. throws SQLException if an error occurs, the parameter index is out of bounds, or when connected to a data source, the number of bytes the driver reads and sends to the database is not equal to the number of bytes specified in length see #getParams Object charStream[]; checkParamIndex(parameterIndex); charStream = new Object[2]; charStream[0] = reader; charStream[1] = new Integer(length); if(params == null){ throw new SQLException("Set initParams() before setCharacterStream"); } params.put(new Integer(parameterIndex - 1), charStream);
public void	setCharacterStream(int parameterIndex, java.io.Reader reader) Sets the designated parameter in this RowSet object's command to the given Reader object. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.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. param parameterIndex the first parameter is 1, the second is 2, ... param reader the java.io.Reader object that contains the Unicode data exception SQLException if a database access error occurs or this method is called on a closed PreparedStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length) Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.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. param parameterName the name of the parameter param reader the java.io.Reader object that contains the UNICODE data used as the designated parameter param length the number of characters in the stream exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setCharacterStream(java.lang.String parameterName, java.io.Reader reader) Sets the designated parameter to the given Reader object. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.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. param parameterName the name of the parameter param reader the java.io.Reader object that contains the Unicode data exception SQLException if a database access error occurs or this method is called on a closed CallableStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setClob(int parameterIndex, java.io.Reader reader, long length) Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB param parameterIndex index of the first parameter is 1, the second is 2, ... param reader An object that contains the data to set the parameter value to. param length the number of characters in the parameter data. throws SQLException if a database access error occurs, this method is called on a closed PreparedStatement, if parameterIndex does not correspond to a parameter marker in the SQL statement, or if the length specified is less than zero. throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setClob(int parameterIndex, java.io.Reader reader) Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARCHAR or a CLOB 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. param parameterIndex index of the first parameter is 1, the second is 2, ... param 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 closed PreparedStatementor if parameterIndex does not correspond to a parameter marker in the SQL statement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setClob(java.lang.String parameterName, java.io.Reader reader, long length) Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARCHAR or a CLOB param parameterName the name of the parameter to be set param reader An object that contains the data to set the parameter value to. param 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 closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setClob(java.lang.String parameterName, java.sql.Clob x) Sets the designated parameter to the given java.sql.Clob object. The driver converts this to an SQL CLOB value when it sends it to the database. param parameterName the name of the parameter param x a Clob object that maps an SQL CLOB value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setClob(java.lang.String parameterName, java.io.Reader reader) Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARCHAR or a CLOB 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. param parameterName the name of the parameter param reader 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 closed CallableStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setClob(int parameterIndex, java.sql.Clob x) Sets the designated parameter to the given Clob object in the Java programming language. The driver converts this to an SQL CLOB value when it sends it to the database. Internally, the Clob is represented as a SerialClob to ensure serializability. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. After this method has been called, a call to the method getParams will return an object array of the current command parameters, which will include the Clob object set for placeholder parameter number parameterIndex. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x a Clob object representing an SQL CLOB value; cannot be null throws SQLException if an error occurs; the parameter index is out of bounds or the Clob is null see #getParams see javax.sql.rowset.serial.SerialBlob checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setClob"); } params.put(new Integer(parameterIndex - 1), new SerialClob(x));
public void	setCommand(java.lang.String cmd) Sets this RowSet object's command property to the given String object and clears the parameters, if any, that were set for the previous command. The command property may not be needed if the RowSet object gets its data from a source that does not support commands, such as a spreadsheet or other tabular file. Thus, this property is optional and may be null. param cmd a String object containing an SQL query that will be set as this RowSet object's command property; may be null but may not be an empty string throws SQLException if an empty string is provided as the command value see #getCommand // cmd equal to null or // cmd with length 0 (implies url =="") // are not independent events. if(cmd == null) { command = null; } else if (cmd.length() == 0) { throw new SQLException("Invalid command string detected. " + "Cannot be of length less than 0"); } else { // "unbind" any parameters from any previous command. if(params == null){ throw new SQLException("Set initParams() before setCommand"); } params.clear(); command = new String(cmd); }
public void	setConcurrency(int concurrency) Sets the concurrency for this RowSet object to the specified concurrency. The default concurrency for any RowSet object (connected or disconnected) is ResultSet.CONCUR_UPDATABLE, but this method may be called at any time to change the concurrency. param concurrency one of the following constants: ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE throws SQLException if the parameter supplied is not one of the following constants: ResultSet.CONCUR_UPDATABLE or ResultSet.CONCUR_READ_ONLY see #getConcurrency see #isReadOnly if((concurrency != ResultSet.CONCUR_READ_ONLY) && (concurrency != ResultSet.CONCUR_UPDATABLE)) { throw new SQLException("Invalid concurrency set. Must be either " + "ResultSet.CONCUR_READ_ONLY or ResultSet.CONCUR_UPDATABLE."); } this.concurrency = concurrency;
public void	setDataSourceName(java.lang.String name) Sets the DataSource name property for this RowSet object to the given logical name and sets this RowSet object's Url property to null. The name must have been bound to a DataSource object in a JNDI naming service so that an application can do a lookup using that name to retrieve the DataSource object bound to it. The DataSource object can then be used to establish a connection to the data source it represents. Users should set either the Url property or the dataSourceName property. If both properties are set, the driver will use the property set most recently. param name a String object with the name that can be supplied to a naming service based on JNDI technology to retrieve the DataSource object that can be used to get a connection; may be null but must not be an empty string throws SQLException if an empty string is provided as the DataSource name see #getDataSourceName if (name == null) { dataSource = null; } else if (name.equals("")) { throw new SQLException("DataSource name cannot be empty string"); } else { dataSource = new String(name); } URL = null;
public void	setDate(java.lang.String parameterName, java.sql.Date x) Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application. The driver converts this to an SQL DATE value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getDate since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object. The driver uses the Calendar object to construct an SQL DATE value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the date taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. param parameterName the name of the parameter param x the parameter value param cal the Calendar object the driver will use to construct the date exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getDate since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setDate(int parameterIndex, java.sql.Date x) Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setDate has been called will return an array with the value to be set for placeholder parameter number parameterIndex being the Date object supplied as the second parameter. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setDate"); } params.put(new Integer(parameterIndex - 1), x);
public void	setDate(int parameterIndex, java.sql.Date x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Date object. When the DBMS does not store time zone information, the driver will use the given Calendar object to construct the SQL DATE value to send to the database. With a Calendar object, the driver can calculate the date taking into account a custom time zone. If no Calendar object is specified, the driver uses the time zone of the Virtual Machine that is running the application. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setDate has been called will return an array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is the given java.sql.Date object. The second element is the value set for cal. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the date being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x a java.sql.Date object representing an SQL DATE value param cal a java.util.Calendar object to use when when constructing the date throws SQLException if an error occurs or the parameter index is out of bounds see #getParams Object date[]; checkParamIndex(parameterIndex); date = new Object[2]; date[0] = x; date[1] = cal; if(params == null){ throw new SQLException("Set initParams() before setDate"); } params.put(new Integer(parameterIndex - 1), date);
public void	setDouble(int parameterIndex, double x) Sets the designated parameter to the given double in the Java programming language. The driver converts this to an SQL DOUBLE value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. S param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setDouble"); } params.put(new Integer(parameterIndex - 1), new Double(x));
public void	setDouble(java.lang.String parameterName, double x) Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getDouble since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setEscapeProcessing(boolean enable) Sets to the given boolean whether or not the driver will scan for escape syntax and do escape substitution before sending SQL statements to the database. The default is for the driver to do escape processing. Note: Since PreparedStatement objects have usually been parsed prior to making this call, disabling escape processing for prepared statements will likely have no effect. param enable true to enable escape processing; false to disable it throws SQLException if an error occurs setting the underlying JDBC technology-enabled driver to process the escape syntax escapeProcessing = enable;
public void	setFetchDirection(int direction) Gives the driver a performance hint as to the direction in which the rows in this RowSet object will be processed. The driver may ignore this hint. A RowSet object inherits the default properties of the ResultSet object from which it got its data. That ResultSet object's default fetch direction is set by the Statement object that created it. This method applies to a RowSet object only while it is connected to a database using a JDBC driver. A RowSet object may use this method at any time to change its setting for the fetch direction. param direction one of ResultSet.FETCH_FORWARD, ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN throws SQLException if (1) the RowSet type is TYPE_FORWARD_ONLY and the given fetch direction is not FETCH_FORWARD or (2) the given fetch direction is not one of the following: ResultSet.FETCH_FORWARD, ResultSet.FETCH_REVERSE, or ResultSet.FETCH_UNKNOWN see #getFetchDirection // Changed the condition checking to the below as there were two // conditions that had to be checked // 1. RowSet is TYPE_FORWARD_ONLY and direction is not FETCH_FORWARD // 2. Direction is not one of the valid values if (((getType() == ResultSet.TYPE_FORWARD_ONLY) && (direction != ResultSet.FETCH_FORWARD)) || ((direction != ResultSet.FETCH_FORWARD) && (direction != ResultSet.FETCH_REVERSE) && (direction != ResultSet.FETCH_UNKNOWN))) { throw new SQLException("Invalid Fetch Direction"); } fetchDir = direction;
public void	setFetchSize(int rows) Sets the fetch size for this RowSet object to the given number of rows. The fetch size gives a JDBC technology-enabled driver ("JDBC driver") a hint as to the number of rows that should be fetched from the database when more rows are needed for this RowSet object. If the fetch size specified is zero, the driver ignores the value and is free to make its own best guess as to what the fetch size should be. A RowSet object inherits the default properties of the ResultSet object from which it got its data. That ResultSet object's default fetch size is set by the Statement object that created it. This method applies to a RowSet object only while it is connected to a database using a JDBC driver. For connected RowSet implementations such as JdbcRowSet, this method has a direct and immediate effect on the underlying JDBC driver. A RowSet object may use this method at any time to change its setting for the fetch size. For RowSet implementations such as CachedRowSet, which operate in a disconnected environment, the SyncProvider object being used may leverage the fetch size to poll the data source and retrieve a number of rows that do not exceed the fetch size and that may form a subset of the actual rows returned by the original query. This is an implementation variance determined by the specific SyncProvider object employed by the disconnected RowSet object. param rows the number of rows to fetch; 0 to let the driver decide what the best fetch size is; must not be less than 0 or more than the maximum number of rows allowed for this RowSet object (the number returned by a call to the method {@link #getMaxRows}) throws SQLException if the specified fetch size is less than 0 or more than the limit for the maximum number of rows see #getFetchSize //Added this checking as maxRows can be 0 when this function is called //maxRows = 0 means rowset can hold any number of rows, os this checking // is needed to take care of this condition. if (getMaxRows() == 0 && rows >= 0) { fetchSize = rows; return; } if ((rows < 0) || (rows > getMaxRows())) { throw new SQLException("Invalid fetch size set. Cannot be of " + "value: " + rows); } fetchSize = rows;
public void	setFloat(int parameterIndex, float x) Sets the designated parameter to the given float in the Java programming language. The driver converts this to an SQL FLOAT value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setFloat"); } params.put(new Integer(parameterIndex - 1), new Float(x));
public void	setFloat(java.lang.String parameterName, float x) Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getFloat since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setInt(int parameterIndex, int x) Sets the designated parameter to an int in the Java programming language. The driver converts this to an SQL INTEGER value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setInt"); } params.put(new Integer(parameterIndex - 1), new Integer(x));
public void	setInt(java.lang.String parameterName, int x) Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getInt since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setLong(int parameterIndex, long x) Sets the designated parameter to the given long in the Java programming language. The driver converts this to an SQL BIGINT value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setLong"); } params.put(new Integer(parameterIndex - 1), new Long(x));
public void	setLong(java.lang.String parameterName, long x) Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getLong since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setMaxFieldSize(int max) Sets the maximum number of bytes that can be used for a column value in this RowSet object to the given number. This limit applies only to columns that hold values of the following types: BINARY, VARBINARY, LONGVARBINARY, CHAR, VARCHAR, and LONGVARCHAR. If the limit is exceeded, the excess data is silently discarded. For maximum portability, it is advisable to use values greater than 256. param max an int indicating the new maximum column size limit; zero means that there is no limit throws SQLException if (1) an error occurs internally setting the maximum limit of the column size or (2) a size of less than 0 is set if (max < 0) { throw new SQLException("Invalid max field size set. Cannot be of " + "value: " + max); } maxFieldSize = max;
public void	setMaxRows(int max) Sets the maximum number of rows that this RowSet object may contain to the given number. If this limit is exceeded, the excess rows are silently dropped. param max an int indicating the current maximum number of rows; zero means that there is no limit throws SQLException if an error occurs internally setting the maximum limit on the number of rows that a JDBC RowSet object can contain; or if max is less than 0; or if max is less than the fetchSize of the RowSet if (max < 0) { throw new SQLException("Invalid max row size set. Cannot be of " + "value: " + max); } else if (max < this.getFetchSize()) { throw new SQLException("Invalid max row size set. Cannot be less " + "than the fetchSize."); } this.maxRows = max;
public void	setNCharacterStream(int parameterIndex, java.io.Reader value, long length) Sets the designated parameter to a Reader object. The Reader 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. param parameterIndex of the first parameter is 1, the second is 2, ... param value the parameter value param length 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 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNCharacterStream(java.lang.String parameterName, java.io.Reader value, long length) Sets the designated parameter to a Reader object. The Reader 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. param parameterName the name of the column to be set param value the parameter value param length 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 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNCharacterStream(java.lang.String parameterName, java.io.Reader value) Sets the designated parameter to a Reader object. The Reader 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. param parameterName the name of the parameter param 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 closed CallableStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNCharacterStream(int parameterIndex, java.io.Reader value) Sets the designated parameter in this RowSet object's command to a Reader object. The Reader 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. param parameterIndex of the first parameter is 1, the second is 2, ... param 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 closed PreparedStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNClob(java.lang.String parameterName, java.sql.NClob value) Sets the designated parameter to a java.sql.NClob object. The object implements the java.sql.NClob interface. This NClob object maps to a SQL NCLOB. param parameterName the name of the column to be set param 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 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNClob(java.lang.String parameterName, java.io.Reader reader, long length) Sets the designated parameter to a Reader object. The reader must contain * the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB param parameterName the name of the parameter to be set param reader An object that contains the data to set the parameter value to. param 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 closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNClob(java.lang.String parameterName, java.io.Reader reader) Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB 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. param parameterName the name of the parameter param reader 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 closed CallableStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNClob(int parameterIndex, java.io.Reader reader, long length) Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the PreparedStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB param parameterIndex index of the first parameter is 1, the second is 2, ... param reader An object that contains the data to set the parameter value to. param 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 closed PreparedStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNClob(int parameterIndex, java.sql.NClob value) Sets the designated parameter to a java.sql.NClob object. The driver converts this oa SQL NCLOB value when it sends it to the database. param parameterIndex of the first parameter is 1, the second is 2, ... param 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 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNClob(int parameterIndex, java.io.Reader reader) Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGNVARCHAR or a NCLOB 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. param parameterIndex index of the first parameter is 1, the second is 2, ... param 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 closed PreparedStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNString(int parameterIndex, java.lang.String value) Sets the designated paramter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR value (depending on the argument's size relative to the driver's limits on NVARCHAR values) when it sends it to the database. param parameterIndex of the first parameter is 1, the second is 2, ... param 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 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNString(java.lang.String parameterName, java.lang.String value) Sets the designated paramter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR param parameterName the name of the column to be set param 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 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNull(int parameterIndex, int sqlType) Sets the designated parameter to SQL NULL. Note that the parameter's SQL type must be specified using one of the type codes defined in java.sql.Types. This SQL type is specified in the second parameter. Note that the second parameter tells the DBMS the data type of the value being set to NULL. Some DBMSs require this information, so it is required in order to make code more portable. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setNull has been called will return an Object array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is null. The second element is the value set for sqlType. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the second placeholder parameter is being set to null, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param sqlType an int that is one of the SQL type codes defined in the class {@link java.sql.Types}. If a non-standard sqlType is supplied, this method will not throw a SQLException. This allows implicit support for non-standard SQL types. throws SQLException if a database access error occurs or the given parameter index is out of bounds see #getParams Object nullVal[]; checkParamIndex(parameterIndex); nullVal = new Object[2]; nullVal[0] = null; nullVal[1] = new Integer(sqlType); if (params == null){ throw new SQLException("Set initParams() before setNull"); } params.put(new Integer(parameterIndex - 1), nullVal);
public void	setNull(int parameterIndex, int sqlType, java.lang.String typeName) Sets the designated parameter to SQL NULL. Although this version of the method setNull is intended for user-defined and REF parameters, this method may be used to set a null parameter for any JDBC type. The following are user-defined types: STRUCT, DISTINCT, and 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 technology-enabled driver does not need the type code or type name information, it may ignore it. If the parameter does not have a user-defined or REF type, the given typeName parameter is ignored. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setNull has been called will return an Object array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is null. The second element is the value set for sqlType, and the third element is the value set for typeName. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the second placeholder parameter is being set to null, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param sqlType a value from java.sql.Types param typeName the fully qualified name of an SQL user-defined type, which is ignored if the parameter is not a user-defined type or REF value throws SQLException if an error occurs or the given parameter index is out of bounds see #getParams Object nullVal[]; checkParamIndex(parameterIndex); nullVal = new Object[3]; nullVal[0] = null; nullVal[1] = new Integer(sqlType); nullVal[2] = new String(typeName); if(params == null){ throw new SQLException("Set initParams() before setNull"); } params.put(new Integer(parameterIndex - 1), nullVal);
public void	setNull(java.lang.String parameterName, int sqlType) Sets the designated parameter to SQL NULL. Note: You must specify the parameter's SQL type. param parameterName the name of the parameter param sqlType the SQL type code defined in java.sql.Types exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setNull(java.lang.String parameterName, int sqlType, java.lang.String typeName) Sets the designated parameter to SQL NULL. This version of the method setNull 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. param parameterName the name of the parameter param sqlType a value from java.sql.Types param typeName the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQL REF value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setObject(java.lang.String parameterName, java.lang.Object x) Sets the value of the designated parameter with the given object. The second parameter must be of type Object; therefore, the java.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 datatabase- 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 method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, or Array, 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. param parameterName the name of the parameter param x the object containing the input parameter value exception SQLException if a database access error occurs, this method is called on a closed CallableStatement or if the given Object parameter is ambiguous exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getObject since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType, int scale) Sets the designated parameter to an Object in the Java programming language. The second parameter must be an Object type. For integral values, the java.lang equivalent objects should be used. For example, use the class Integer for an int. The driver converts this object to the specified target SQL type before sending it to the database. If the object has a custom mapping (is of a class implementing SQLData), the driver should call the method SQLData.writeSQL to write the object to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, 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. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSetexecute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setObject has been called will return an array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is the given Object instance, and the second element is the value set for targetSqlType. The third element is the value set for scale, which the driver will ignore if the type of the object being set is not java.sql.Types.NUMERIC or java.sql.Types.DECIMAL. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the object being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the Object containing the input parameter value; must be an Object type param targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type. If a non-standard targetSqlType is supplied, this method will not throw a SQLException. This allows implicit support for non-standard SQL types. param scale for the types java.sql.Types.DECIMAL and java.sql.Types.NUMERIC, this is the number of digits after the decimal point. For all other types, this value will be ignored. throws SQLException if an error occurs or the parameter index is out of bounds see #getParams Object obj[]; checkParamIndex(parameterIndex); obj = new Object[3]; obj[0] = x; obj[1] = new Integer(targetSqlType); obj[2] = new Integer(scale); if(params == null){ throw new SQLException("Set initParams() before setObject"); } params.put(new Integer(parameterIndex - 1), obj);
public void	setObject(int parameterIndex, java.lang.Object x, int targetSqlType) Sets the value of the designated parameter with the given Object value. This method is like setObject(int parameterIndex, Object x, int targetSqlType, int scale) except that it assumes a scale of zero. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setObject has been called will return an array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is the given Object instance. The second element is the value set for targetSqlType. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the object being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the Object containing the input parameter value; must be an Object type param targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database. If a non-standard targetSqlType is supplied, this method will not throw a SQLException. This allows implicit support for non-standard SQL types. throws SQLException if an error occurs or the parameter index is out of bounds see #getParams Object obj[]; checkParamIndex(parameterIndex); obj = new Object[2]; obj[0] = x; obj[1] = new Integer(targetSqlType); if (params == null){ throw new SQLException("Set initParams() before setObject"); } params.put(new Integer(parameterIndex - 1), obj);
public void	setObject(int parameterIndex, java.lang.Object x) Sets the designated parameter to an Object in the Java programming language. The second parameter must be an Object type. For integral values, the java.lang equivalent objects should be used. For example, use the class Integer for an int. The JDBC specification defines a standard mapping from Java Object types to SQL types. The driver will use this standard mapping to convert the given object to its corresponding SQL type before sending it to the database. If the object has a custom mapping (is of a class implementing SQLData), the driver should call the method SQLData.writeSQL to write the object to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, 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 interface. Note that this method may be used to pass database-specific abstract data types. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. After this method has been called, a call to the method getParams will return an object array of the current command parameters, which will include the Object set for placeholder parameter number parameterIndex. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the object containing the input parameter value throws SQLException if an error occurs the parameter index is out of bounds, or there is ambiguity in the implementation of the object being set see #getParams checkParamIndex(parameterIndex); if (params == null) { throw new SQLException("Set initParams() before setObject"); } params.put(new Integer(parameterIndex - 1), x);
public void	setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale) Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.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 method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, NClob, Struct, java.net.URL, or Array, 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 datatabase- specific abstract data types. param parameterName the name of the parameter param x the object containing the input parameter value param targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type. param 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. exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if targetSqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type see Types see #getObject since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType) Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero. param parameterName the name of the parameter param x the object containing the input parameter value param targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if targetSqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type see #getObject since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setPassword(java.lang.String pass) Sets the password used to create a database connection for this RowSet object to the given String object. Because the password property is not serialized, it is set at run time before calling the method execute. param pass the String object that represents the password that is supplied to the database to create a connection. It may be null. see #getPassword if(pass == null) { password = null; } else { password = new String(pass); }
public void	setQueryTimeout(int seconds) Sets to the given number the maximum number of seconds the driver will wait for a query to execute. If the limit is exceeded, an SQLException is thrown. param seconds the new query time-out limit in seconds; zero means that there is no limit; must not be less than zero throws SQLException if an error occurs setting the query time-out or if the query time-out value is less than 0 if (seconds < 0) { throw new SQLException("Invalid query timeout value set. Cannot be " + "of value: " + seconds); } this.queryTimeout = seconds;
public void	setReadOnly(boolean value) Sets this RowSet object's readOnly property to the given boolean. param value true to indicate that this RowSet object is read-only; false to indicate that it is updatable readOnly = value;
public void	setRef(int parameterIndex, java.sql.Ref ref) Sets the designated parameter to the given Ref object in the Java programming language. The driver converts this to an SQL REF value when it sends it to the database. Internally, the Ref is represented as a SerialRef to ensure serializability. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. After this method has been called, a call to the method getParams will return an object array of the current command parameters, which will include the Ref object set for placeholder parameter number parameterIndex. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param ref a Ref object representing an SQL REF value; cannot be null throws SQLException if an error occurs; the parameter index is out of bounds or the Ref object is null; or the Ref object returns a null base type name. see #getParams see javax.sql.rowset.serial.SerialRef checkParamIndex(parameterIndex); if (params == null) { throw new SQLException("Set initParams() before setRef"); } params.put(new Integer(parameterIndex - 1), new SerialRef(ref));
public void	setRowId(int parameterIndex, java.sql.RowId x) Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID value when it sends it to the database param parameterIndex the first parameter is 1, the second is 2, ... param x the parameter value throws SQLException if a database access error occurs since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setRowId(java.lang.String parameterName, java.sql.RowId x) Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID when it sends it to the database. param parameterName the name of the parameter param x the parameter value throws SQLException if a database access error occurs since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setSQLXML(int parameterIndex, java.sql.SQLXML xmlObject) Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database. param parameterIndex index of the first parameter is 1, the second is 2, ... param xmlObject a SQLXML object that maps an SQL XML value throws SQLException if a database access error occurs, this method is called on a closed result set, the java.xml.transform.Result, Writer or OutputStream has not been closed for the SQLXML object or if there is an error processing the XML value. The getCause method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML. since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setSQLXML(java.lang.String parameterName, java.sql.SQLXML xmlObject) Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database. param parameterName the name of the parameter param xmlObject a SQLXML object that maps an SQL XML value throws SQLException if a database access error occurs, this method is called on a closed result set, the java.xml.transform.Result, Writer or OutputStream has not been closed for the SQLXML object or if there is an error processing the XML value. The getCause method of the exception may provide a more detailed exception, for example, if the stream does not contain valid XML. since 1.6 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setShort(int parameterIndex, short x) Sets the designated parameter to the given short in the Java programming language. The driver converts this to an SQL SMALLINT value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setShort"); } params.put(new Integer(parameterIndex - 1), new Short(x));
public void	setShort(java.lang.String parameterName, short x) Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getShort since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setShowDeleted(boolean value) Sets the property showDeleted to the given boolean value, which determines whether rows marked for deletion appear in the set of current rows. param value true if deleted rows should be shown; false otherwise throws SQLException if an error occurs setting whether deleted rows are visible or not see #getShowDeleted showDeleted = value;
public void	setString(int parameterIndex, java.lang.String x) Sets the designated parameter to the given String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the parameter value throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setString"); } params.put(new Integer(parameterIndex - 1), x);
public void	setString(java.lang.String parameterName, java.lang.String x) Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getString since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setTime(java.lang.String parameterName, java.sql.Time x) Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getTime since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the time taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. param parameterName the name of the parameter param x the parameter value param cal the Calendar object the driver will use to construct the time exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getTime since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setTime(int parameterIndex, java.sql.Time x) Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of the method setTime has been called will return an array of the parameters that have been set. The parameter to be set for parameter placeholder number parameterIndex will be the Time object that was set as the second parameter to this method. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x a java.sql.Time object, which is to be set as the value for placeholder parameter parameterIndex throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setTime"); } params.put(new Integer(parameterIndex - 1), x);
public void	setTime(int parameterIndex, java.sql.Time x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Time object. The driver converts this to an SQL TIME value when it sends it to the database. When the DBMS does not store time zone information, the driver will use the given Calendar object to construct the SQL TIME value to send to the database. With a Calendar object, the driver can calculate the date taking into account a custom time zone. If no Calendar object is specified, the driver uses the time zone of the Virtual Machine that is running the application. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setTime has been called will return an array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is the given java.sql.Time object. The second element is the value set for cal. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the time being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x a java.sql.Time object param cal the java.util.Calendar object the driver can use to construct the time throws SQLException if an error occurs or the parameter index is out of bounds see #getParams Object time[]; checkParamIndex(parameterIndex); time = new Object[2]; time[0] = x; time[1] = cal; if(params == null){ throw new SQLException("Set initParams() before setTime"); } params.put(new Integer(parameterIndex - 1), time);
public void	setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIMESTAMP value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the timestamp taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application. param parameterName the name of the parameter param x the parameter value param cal the Calendar object the driver will use to construct the timestamp exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getTimestamp since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setTimestamp(int parameterIndex, java.sql.Timestamp x) Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setTimestamp has been called will return an array with the value for parameter placeholder number parameterIndex being the Timestamp object that was supplied as the second parameter to this method. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x a java.sql.Timestamp object throws SQLException if an error occurs or the parameter index is out of bounds see #getParams checkParamIndex(parameterIndex); if(params == null){ throw new SQLException("Set initParams() before setTimestamp"); } params.put(new Integer(parameterIndex - 1), x);
public void	setTimestamp(int parameterIndex, java.sql.Timestamp x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Timestamp object. The driver converts this to an SQL TIMESTAMP value when it sends it to the database. When the DBMS does not store time zone information, the driver will use the given Calendar object to construct the SQL TIMESTAMP value to send to the database. With a Calendar object, the driver can calculate the timestamp taking into account a custom time zone. If no Calendar object is specified, the driver uses the time zone of the Virtual Machine that is running the application. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Methods such as execute and populate must be provided in any class that extends this class and implements one or more of the standard JSR-114 RowSet interfaces. NOTE: JdbcRowSet does not require the populate method as it is undefined in this class. Calls made to the method getParams after this version of setTimestamp has been called will return an array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is the given java.sql.Timestamp object. The second element is the value set for cal. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the timestamp being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x a java.sql.Timestamp object param cal the java.util.Calendar object the driver can use to construct the timestamp throws SQLException if an error occurs or the parameter index is out of bounds see #getParams Object timestamp[]; checkParamIndex(parameterIndex); timestamp = new Object[2]; timestamp[0] = x; timestamp[1] = cal; if(params == null){ throw new SQLException("Set initParams() before setTimestamp"); } params.put(new Integer(parameterIndex - 1), timestamp);
public void	setTimestamp(java.lang.String parameterName, java.sql.Timestamp x) Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database. param parameterName the name of the parameter param x the parameter value exception SQLException if a database access error occurs or this method is called on a closed CallableStatement exception SQLFeatureNotSupportedException if the JDBC driver does not support this method see #getTimestamp since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setTransactionIsolation(int level) Sets the transaction isolation property for this JDBC RowSet object to the given constant. The DBMS will use this transaction isolation level for transactions if it can. For RowSet implementations such as the CachedRowSet that operate in a disconnected environment, the SyncProvider object being used offers complementary locking and data integrity options. The options described below are pertinent only to connected RowSet objects (JdbcRowSet objects). param level one of the following constants, listed in ascending order: Connection.TRANSACTION_NONE, Connection.TRANSACTION_READ_UNCOMMITTED, Connection.TRANSACTION_READ_COMMITTED, Connection.TRANSACTION_REPEATABLE_READ, or Connection.TRANSACTION_SERIALIZABLE throws SQLException if the given parameter is not one of the Connection constants see javax.sql.rowset.spi.SyncFactory see javax.sql.rowset.spi.SyncProvider see #getTransactionIsolation if ((level != Connection.TRANSACTION_NONE) && (level != Connection.TRANSACTION_READ_COMMITTED) && (level != Connection.TRANSACTION_READ_UNCOMMITTED) && (level != Connection.TRANSACTION_REPEATABLE_READ) && (level != Connection.TRANSACTION_SERIALIZABLE)) { throw new SQLException("Invalid transaction isolation set. Must " + "be either " + "Connection.TRANSACTION_NONE or " + "Connection.TRANSACTION_READ_UNCOMMITTED or " + "Connection.TRANSACTION_READ_COMMITTED or " + "Connection.RRANSACTION_REPEATABLE_READ or " + "Connection.TRANSACTION_SERIALIZABLE"); } this.isolation = level;
public void	setType(int type) Sets the type for this RowSet object to the specified type. The default type is ResultSet.TYPE_SCROLL_INSENSITIVE. param type one of the following constants: ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE throws SQLException if the parameter supplied is not one of the following constants: ResultSet.TYPE_FORWARD_ONLY or ResultSet.TYPE_SCROLL_INSENSITIVE ResultSet.TYPE_SCROLL_SENSITIVE see #getConcurrency see #getType if ((type != ResultSet.TYPE_FORWARD_ONLY) && (type != ResultSet.TYPE_SCROLL_INSENSITIVE) && (type != ResultSet.TYPE_SCROLL_SENSITIVE)) { throw new SQLException("Invalid type of RowSet set. Must be either " + "ResultSet.TYPE_FORWARD_ONLY or ResultSet.TYPE_SCROLL_INSENSITIVE " + "or ResultSet.TYPE_SCROLL_SENSITIVE."); } this.rowSetType = type;
public void	setTypeMap(java.util.Map map) Installs the given java.util.Map object as the type map associated with the Connection object for this RowSet object. The custom mapping indicated in this type map will be used unless a different type map is explicitly supplied to a method, in which case the type map supplied will be used. param map a java.util.Map object that contains the mapping from SQL type names for user defined types (UDT) to classes in the Java programming language. Each entry in the Map object consists of the fully qualified SQL name of a UDT and the Class object for the SQLData implementation of that UDT. May be null. this.map = map;
public void	setURL(int parameterIndex, java.net.URL x) Sets the designated parameter to the given java.net.URL value. The driver converts this to an SQL DATALINK value when it sends it to the database. param parameterIndex the first parameter is 1, the second is 2, ... param x the java.net.URL object to be set exception SQLException if a database access error occurs or this method is called on a closed PreparedStatement throws SQLFeatureNotSupportedException if the JDBC driver does not support this method since 1.4 throw new SQLFeatureNotSupportedException("Feature not supported");
public void	setUnicodeStream(int parameterIndex, java.io.InputStream x, int length) Sets the designated parameter to the given java.io.InputStream object, which will have the specified number of bytes. The contents of the stream will be read and sent to the database. This method throws an SQLException if the number of bytes read and sent to the database is not equal to length. When a very large Unicode value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream object. A JDBC technology-enabled driver will read the data from the stream as needed, until it reaches end-of-file. The driver will do any necessary conversion from Unicode to the database CHAR format. The byte format of the Unicode stream must be Java UTF-8, as defined in the Java Virtual Machine Specification. Note: This stream object can be either a standard Java stream object or your own subclass that implements the standard interface. This method is deprecated; the method getCharacterStream should be used in its place. The parameter value set by this method is stored internally and will be supplied as the appropriate parameter in this RowSet object's command when the method execute is called. Calls made to the method getParams after setUnicodeStream has been called will return an array containing the parameter values that have been set. In that array, the element that represents the values set with this method will itself be an array. The first element of that array is the given java.io.InputStream object. The second element is the value set for length. The third element is an internal BaseRowSet constant specifying that the stream passed to this method is a Unicode stream. The parameter number is indicated by an element's position in the array returned by the method getParams, with the first element being the value for the first placeholder parameter, the second element being the value for the second placeholder parameter, and so on. In other words, if the input stream being set is the value for the second placeholder parameter, the array containing it will be the second element in the array returned by getParams. Note that because the numbering of elements in an array starts at zero, the array element that corresponds to placeholder parameter number parameterIndex is element number parameterIndex -1. param parameterIndex the ordinal number of the placeholder parameter in this RowSet object's command that is to be set. The first parameter is 1, the second is 2, and so on; must be 1 or greater param x the java.io.InputStream object that contains the UNICODE parameter value param length the number of bytes in the input stream throws SQLException if an error occurs, the parameter index is out of bounds, or the number of bytes the driver reads and sends to the database is not equal to the number of bytes specified in length deprecated getCharacterStream should be used in its place see #getParams Object unicodeStream[]; checkParamIndex(parameterIndex); unicodeStream = new Object[3]; unicodeStream[0] = x; unicodeStream[1] = new Integer(length); unicodeStream[2] = new Integer(UNICODE_STREAM_PARAM); if(params == null){ throw new SQLException("Set initParams() before setUnicodeStream"); } params.put(new Integer(parameterIndex - 1), unicodeStream);
public void	setUrl(java.lang.String url) Sets the Url property for this RowSet object to the given String object and sets the dataSource name property to null. The Url property is a JDBC URL that is used when the connection is created using a JDBC technology-enabled driver ("JDBC driver") and the DriverManager. The correct JDBC URL for the specific driver to be used can be found in the driver documentation. Although there are guidelines for for how a JDBC URL is formed, a driver vendor can specify any String object except one with a length of 0 (an empty string). Setting the Url property is optional if connections are established using a DataSource object instead of the DriverManager. The driver will use either the URL property or the dataSourceName property to create a connection, whichever was specified most recently. If an application uses a JDBC URL, it must load a JDBC driver that accepts the JDBC URL before it uses the RowSet object to connect to a database. The RowSet object will use the URL internally to create a database connection in order to read or write data. param url a String object that contains the JDBC URL that will be used to establish the connection to a database for this RowSet object; may be null but must not be an empty string throws SQLException if an error occurs setting the Url property or the parameter supplied is a string with a length of 0 (an empty string) see #getUrl if(url == null) { url = null; } else if (url.length() < 1) { throw new SQLException("Invalid url string detected. " + "Cannot be of length less than 1"); } else { URL = new String(url); } dataSource = null;
public void	setUsername(java.lang.String name) Sets the username property for this RowSet object to the given user name. Because it is not serialized, the username property is set at run time before calling the method execute. param name the String object containing the user name that is supplied to the data source to create a connection. It may be null. see #getUsername if(name == null) { username = null; } else { username = new String(name); }