[Springframework-cvs] spring/src/org/springframework/jdbc/core JdbcOperations.java,1.37,1.38

[Juergen H. <jho...@us...>]

Update of /cvsroot/springframework/spring/src/org/springframework/jdbc/core
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18032/src/org/springframework/jdbc/core

Modified Files:
	JdbcOperations.java 
Log Message:
refined javadoc

Index: JdbcOperations.java
===================================================================
RCS file: /cvsroot/springframework/spring/src/org/springframework/jdbc/core/JdbcOperations.java,v
retrieving revision 1.37
retrieving revision 1.38
diff -C2 -d -r1.37 -r1.38
*** JdbcOperations.java	8 Apr 2006 20:50:08 -0000	1.37
--- JdbcOperations.java	20 Apr 2006 10:32:49 -0000	1.38
***************
*** 325,332 ****
--- 325,335 ----
  	 * Query using a prepared statement, reading the ResultSet with a
  	 * ResultSetExtractor.
+ 	 * <p>A PreparedStatementCreator can either be implemented directly or
+ 	 * configured through a PreparedStatementCreatorFactory.
  	 * @param psc object that can create a PreparedStatement given a Connection
  	 * @param rse object that will extract results
  	 * @return an arbitrary result object, as returned by the ResultSetExtractor
  	 * @throws DataAccessException if there is any problem
+ 	 * @see PreparedStatementCreatorFactory
  	 */
  	Object query(PreparedStatementCreator psc, ResultSetExtractor rse) throws DataAccessException;
***************
*** 379,385 ****
--- 382,391 ----
  	 * Query using a prepared statement, reading the ResultSet on a per-row
  	 * basis with a RowCallbackHandler.
+ 	 * <p>A PreparedStatementCreator can either be implemented directly or
+ 	 * configured through a PreparedStatementCreatorFactory.
  	 * @param psc object that can create a PreparedStatement given a Connection
  	 * @param rch object that will extract results, one row at a time
  	 * @throws DataAccessException if there is any problem
+ 	 * @see PreparedStatementCreatorFactory
  	 */
  	void query(PreparedStatementCreator psc, RowCallbackHandler rch) throws DataAccessException;
***************
*** 431,438 ****
--- 437,447 ----
  	 * Query using a prepared statement, mapping each row to a Java object
  	 * via a RowMapper.
+ 	 * <p>A PreparedStatementCreator can either be implemented directly or
+ 	 * configured through a PreparedStatementCreatorFactory.
  	 * @param psc object that can create a PreparedStatement given a Connection
  	 * @param rowMapper object that will map one object per row
  	 * @return the result List, containing mapped objects
  	 * @throws DataAccessException if there is any problem
+ 	 * @see PreparedStatementCreatorFactory
  	 */
  	List query(PreparedStatementCreator psc, RowMapper rowMapper) throws DataAccessException;
***************
*** 782,788 ****
--- 791,800 ----
  	 * Issue an update using a PreparedStatementCreator to provide SQL and any
  	 * required parameters.
+ 	 * <p>A PreparedStatementCreator can either be implemented directly or
+ 	 * configured through a PreparedStatementCreatorFactory.
  	 * @param psc object that provides SQL and any necessary parameters
  	 * @return the number of rows affected
  	 * @throws DataAccessException if there is any problem issuing the update
+ 	 * @see PreparedStatementCreatorFactory
  	 */
  	int update(PreparedStatementCreator psc) throws DataAccessException;
***************
*** 790,798 ****
  	/**
  	 * Issue an update using a PreparedStatementCreator to provide SQL and any
! 	 * required parameters.  Generetaed keys will to be returned by the List parameter.
  	 * @param psc object that provides SQL and any necessary parameters
  	 * @param generatedKeyHolder KeyHolder that will hold the generated keys
  	 * @return the number of rows affected
  	 * @throws DataAccessException if there is any problem issuing the update
  	 */
  	int update(PreparedStatementCreator psc, KeyHolder generatedKeyHolder) throws DataAccessException;
--- 802,815 ----
  	/**
  	 * Issue an update using a PreparedStatementCreator to provide SQL and any
! 	 * required parameters. Generated keys will be put into the given KeyHolder.
! 	 * <p>Note that the given PreparedStatementCreator has to create a statement
! 	 * with activated extraction of generated keys (a JDBC 3.0 feature). This can
! 	 * either be done directly or through using a PreparedStatementCreatorFactory.
  	 * @param psc object that provides SQL and any necessary parameters
  	 * @param generatedKeyHolder KeyHolder that will hold the generated keys
  	 * @return the number of rows affected
  	 * @throws DataAccessException if there is any problem issuing the update
+ 	 * @see PreparedStatementCreatorFactory
+ 	 * @see org.springframework.jdbc.support.GeneratedKeyHolder
  	 */
  	int update(PreparedStatementCreator psc, KeyHolder generatedKeyHolder) throws DataAccessException;
***************
*** 803,807 ****
  	 * method will create the PreparedStatement: The PreparedStatementSetter
  	 * just needs to set parameters.
! 	 * @param sql SQL, containing bind parameters
  	 * @param pss helper that sets bind parameters. If this is <code>null</code>
  	 * we run an update with static SQL.
--- 820,824 ----
  	 * method will create the PreparedStatement: The PreparedStatementSetter
  	 * just needs to set parameters.
! 	 * @param sql SQL containing bind parameters
  	 * @param pss helper that sets bind parameters. If this is <code>null</code>
  	 * we run an update with static SQL.
***************
*** 813,817 ****
  	/**
  	 * Issue an update via a prepared statement, binding the given arguments.
! 	 * @param sql SQL, containing bind parameters
  	 * @param args arguments to bind to the query
  	 * @param argTypes SQL types of the arguments
--- 830,834 ----
  	/**
  	 * Issue an update via a prepared statement, binding the given arguments.
! 	 * @param sql SQL containing bind parameters
  	 * @param args arguments to bind to the query
  	 * @param argTypes SQL types of the arguments
***************
*** 825,829 ****
  	/**
  	 * Issue an update via a prepared statement, binding the given arguments.
! 	 * @param sql SQL, containing bind parameters
  	 * @param args arguments to bind to the query
  	 * (leaving it to the PreparedStatement to guess the corresponding SQL type)
--- 842,846 ----
  	/**
  	 * Issue an update via a prepared statement, binding the given arguments.
! 	 * @param sql SQL containing bind parameters
  	 * @param args arguments to bind to the query
  	 * (leaving it to the PreparedStatement to guess the corresponding SQL type)