From fc92c0010e7d3b89fed511121acf2a4d1f06ac70 Mon Sep 17 00:00:00 2001 From: Juergen Hoeller Date: Thu, 27 Nov 2014 18:01:19 +0100 Subject: [PATCH] Revised SqlRowSet javadoc and support for JDBC 4.x ResultSet additions Issue: SPR-12476 Issue: SPR-12480 --- .../rowset/ResultSetWrappingSqlRowSet.java | 150 +++++--- .../jdbc/support/rowset/SqlRowSet.java | 357 ++++++++++-------- 2 files changed, 303 insertions(+), 204 deletions(-) diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSet.java b/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSet.java index 3ccb3166612..f56a9b58caa 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSet.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/ResultSetWrappingSqlRowSet.java @@ -221,12 +221,12 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { } /** - * @see java.sql.ResultSet#getDate(int, java.util.Calendar) + * @see java.sql.ResultSet#getDate(int) */ @Override - public Date getDate(int columnIndex, Calendar cal) throws InvalidResultSetAccessException { + public Date getDate(int columnIndex) throws InvalidResultSetAccessException { try { - return this.resultSet.getDate(columnIndex, cal); + return this.resultSet.getDate(columnIndex); } catch (SQLException se) { throw new InvalidResultSetAccessException(se); @@ -234,33 +234,34 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { } /** - * @see java.sql.ResultSet#getDate(int) + * @see java.sql.ResultSet#getDate(String) */ @Override - public Date getDate(int columnIndex) throws InvalidResultSetAccessException { + public Date getDate(String columnLabel) throws InvalidResultSetAccessException { + return getDate(findColumn(columnLabel)); + } + + /** + * @see java.sql.ResultSet#getDate(int, Calendar) + */ + @Override + public Date getDate(int columnIndex, Calendar cal) throws InvalidResultSetAccessException { try { - return this.resultSet.getDate(columnIndex); + return this.resultSet.getDate(columnIndex, cal); } catch (SQLException se) { throw new InvalidResultSetAccessException(se); } } + /** - * @see java.sql.ResultSet#getDate(String, java.util.Calendar) + * @see java.sql.ResultSet#getDate(String, Calendar) */ @Override public Date getDate(String columnLabel, Calendar cal) throws InvalidResultSetAccessException { return getDate(findColumn(columnLabel), cal); } - /** - * @see java.sql.ResultSet#getDate(String) - */ - @Override - public Date getDate(String columnLabel) throws InvalidResultSetAccessException { - return getDate(findColumn(columnLabel)); - } - /** * @see java.sql.ResultSet#getDouble(int) */ @@ -302,6 +303,7 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { public float getFloat(String columnLabel) throws InvalidResultSetAccessException { return getFloat(findColumn(columnLabel)); } + /** * @see java.sql.ResultSet#getInt(int) */ @@ -345,18 +347,26 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { } /** - * @see java.sql.ResultSet#getObject(int, java.util.Map) + * @see java.sql.ResultSet#getNString(int) */ @Override - public Object getObject(int i, Map> map) throws InvalidResultSetAccessException { + public String getNString(int columnIndex) throws InvalidResultSetAccessException { try { - return this.resultSet.getObject(i, map); + return this.resultSet.getNString(columnIndex); } catch (SQLException se) { throw new InvalidResultSetAccessException(se); } } + /** + * @see java.sql.ResultSet#getNString(String) + */ + @Override + public String getNString(String columnLabel) throws InvalidResultSetAccessException { + return getNString(findColumn(columnLabel)); + } + /** * @see java.sql.ResultSet#getObject(int) */ @@ -371,19 +381,53 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { } /** - * @see java.sql.ResultSet#getObject(String, java.util.Map) + * @see java.sql.ResultSet#getObject(String) */ @Override - public Object getObject(String columnLabel, Map> map) throws InvalidResultSetAccessException { + public Object getObject(String columnLabel) throws InvalidResultSetAccessException { + return getObject(findColumn(columnLabel)); + } + + /** + * @see java.sql.ResultSet#getObject(int, Map) + */ + @Override + public Object getObject(int columnIndex, Map> map) throws InvalidResultSetAccessException { + try { + return this.resultSet.getObject(columnIndex, map); + } + catch (SQLException se) { + throw new InvalidResultSetAccessException(se); + } + } + + /** + * @see java.sql.ResultSet#getObject(String, Map) + */ + @Override + public Object getObject(String columnLabel, Map> map) throws InvalidResultSetAccessException { return getObject(findColumn(columnLabel), map); } /** - * @see java.sql.ResultSet#getObject(String) + * @see java.sql.ResultSet#getObject(int, Class) */ @Override - public Object getObject(String columnLabel) throws InvalidResultSetAccessException { - return getObject(findColumn(columnLabel)); + public T getObject(int columnIndex, Class type) throws InvalidResultSetAccessException { + try { + return this.resultSet.getObject(columnIndex, type); + } + catch (SQLException se) { + throw new InvalidResultSetAccessException(se); + } + } + + /** + * @see java.sql.ResultSet#getObject(String, Class) + */ + @Override + public T getObject(String columnLabel, Class type) throws InvalidResultSetAccessException { + return getObject(findColumn(columnLabel), type); } /** @@ -428,19 +472,6 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { return getString(findColumn(columnLabel)); } - /** - * @see java.sql.ResultSet#getTime(int, java.util.Calendar) - */ - @Override - public Time getTime(int columnIndex, Calendar cal) throws InvalidResultSetAccessException { - try { - return this.resultSet.getTime(columnIndex, cal); - } - catch (SQLException se) { - throw new InvalidResultSetAccessException(se); - } - } - /** * @see java.sql.ResultSet#getTime(int) */ @@ -454,14 +485,6 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { } } - /** - * @see java.sql.ResultSet#getTime(String, java.util.Calendar) - */ - @Override - public Time getTime(String columnLabel, Calendar cal) throws InvalidResultSetAccessException { - return getTime(findColumn(columnLabel), cal); - } - /** * @see java.sql.ResultSet#getTime(String) */ @@ -471,18 +494,26 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { } /** - * @see java.sql.ResultSet#getTimestamp(int, java.util.Calendar) + * @see java.sql.ResultSet#getTime(int, Calendar) */ @Override - public Timestamp getTimestamp(int columnIndex, Calendar cal) throws InvalidResultSetAccessException { + public Time getTime(int columnIndex, Calendar cal) throws InvalidResultSetAccessException { try { - return this.resultSet.getTimestamp(columnIndex, cal); + return this.resultSet.getTime(columnIndex, cal); } catch (SQLException se) { throw new InvalidResultSetAccessException(se); } } + /** + * @see java.sql.ResultSet#getTime(String, Calendar) + */ + @Override + public Time getTime(String columnLabel, Calendar cal) throws InvalidResultSetAccessException { + return getTime(findColumn(columnLabel), cal); + } + /** * @see java.sql.ResultSet#getTimestamp(int) */ @@ -497,19 +528,32 @@ public class ResultSetWrappingSqlRowSet implements SqlRowSet { } /** - * @see java.sql.ResultSet#getTimestamp(String, java.util.Calendar) + * @see java.sql.ResultSet#getTimestamp(String) */ @Override - public Timestamp getTimestamp(String columnLabel, Calendar cal) throws InvalidResultSetAccessException { - return getTimestamp(findColumn(columnLabel), cal); + public Timestamp getTimestamp(String columnLabel) throws InvalidResultSetAccessException { + return getTimestamp(findColumn(columnLabel)); } /** - * @see java.sql.ResultSet#getTimestamp(String) + * @see java.sql.ResultSet#getTimestamp(int, Calendar) */ @Override - public Timestamp getTimestamp(String columnLabel) throws InvalidResultSetAccessException { - return getTimestamp(findColumn(columnLabel)); + public Timestamp getTimestamp(int columnIndex, Calendar cal) throws InvalidResultSetAccessException { + try { + return this.resultSet.getTimestamp(columnIndex, cal); + } + catch (SQLException se) { + throw new InvalidResultSetAccessException(se); + } + } + + /** + * @see java.sql.ResultSet#getTimestamp(String, Calendar) + */ + @Override + public Timestamp getTimestamp(String columnLabel, Calendar cal) throws InvalidResultSetAccessException { + return getTimestamp(findColumn(columnLabel), cal); } diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/SqlRowSet.java b/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/SqlRowSet.java index 88900de9191..f8d87744263 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/SqlRowSet.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/support/rowset/SqlRowSet.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2012 the original author or authors. + * Copyright 2002-2014 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -27,8 +27,8 @@ import java.util.Map; import org.springframework.jdbc.InvalidResultSetAccessException; /** - * Mirror interface for {@code javax.sql.RowSet}, representing - * disconnected {@code java.sql.ResultSet} data. + * Mirror interface for {@link javax.sql.RowSet}, representing + * disconnected {@link java.sql.ResultSet} data. * *

The main difference to the standard JDBC RowSet is that an SQLException * is never thrown here. This allows a SqlRowSet to be used without having @@ -51,15 +51,15 @@ import org.springframework.jdbc.InvalidResultSetAccessException; public interface SqlRowSet extends Serializable { /** - * Retrieves the meta data (number, types and properties for the columns) - * of this row set. + * Retrieve the meta data, i.e. number, types and properties + * for the columns of this row set. * @return a corresponding SqlRowSetMetaData instance * @see java.sql.ResultSet#getMetaData() */ SqlRowSetMetaData getMetaData(); /** - * Maps the given column label to its column index. + * Map the given column label to its column index. * @param columnLabel the name of the column * @return the column index for the given column label * @see java.sql.ResultSet#findColumn(String) @@ -70,8 +70,8 @@ public interface SqlRowSet extends Serializable { // RowSet methods for extracting data values /** - * Retrieves the value of the indicated column in the current row as - * an BigDecimal object. + * Retrieve the value of the indicated column in the current row + * as a BigDecimal object. * @param columnIndex the column index * @return an BigDecimal object representing the column value * @see java.sql.ResultSet#getBigDecimal(int) @@ -79,17 +79,17 @@ public interface SqlRowSet extends Serializable { BigDecimal getBigDecimal(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * an BigDecimal object. + * Retrieve the value of the indicated column in the current row + * as a BigDecimal object. * @param columnLabel the column label * @return an BigDecimal object representing the column value - * @see java.sql.ResultSet#getBigDecimal(java.lang.String) + * @see java.sql.ResultSet#getBigDecimal(String) */ BigDecimal getBigDecimal(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a boolean. + * Retrieve the value of the indicated column in the current row + * as a boolean. * @param columnIndex the column index * @return a boolean representing the column value * @see java.sql.ResultSet#getBoolean(int) @@ -97,17 +97,17 @@ public interface SqlRowSet extends Serializable { boolean getBoolean(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a boolean. + * Retrieve the value of the indicated column in the current row + * as a boolean. * @param columnLabel the column label * @return a boolean representing the column value - * @see java.sql.ResultSet#getBoolean(java.lang.String) + * @see java.sql.ResultSet#getBoolean(String) */ boolean getBoolean(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a byte. + * Retrieve the value of the indicated column in the current row + * as a byte. * @param columnIndex the column index * @return a byte representing the column value * @see java.sql.ResultSet#getByte(int) @@ -115,55 +115,55 @@ public interface SqlRowSet extends Serializable { byte getByte(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a byte. + * Retrieve the value of the indicated column in the current row + * as a byte. * @param columnLabel the column label * @return a byte representing the column value - * @see java.sql.ResultSet#getByte(java.lang.String) + * @see java.sql.ResultSet#getByte(String) */ byte getByte(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Date object. + * Retrieve the value of the indicated column in the current row + * as a Date object. * @param columnIndex the column index - * @param cal the Calendar to use in constructing the Date * @return a Date object representing the column value - * @see java.sql.ResultSet#getDate(int, java.util.Calendar) + * @see java.sql.ResultSet#getDate(int) */ - Date getDate(int columnIndex, Calendar cal) throws InvalidResultSetAccessException; + Date getDate(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Date object. - * @param columnIndex the column index + * Retrieve the value of the indicated column in the current row + * as a Date object. + * @param columnLabel the column label * @return a Date object representing the column value - * @see java.sql.ResultSet#getDate(int) + * @see java.sql.ResultSet#getDate(String) */ - Date getDate(int columnIndex) throws InvalidResultSetAccessException; + Date getDate(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Date object. - * @param columnLabel the column label + * Retrieve the value of the indicated column in the current row + * as a Date object. + * @param columnIndex the column index * @param cal the Calendar to use in constructing the Date * @return a Date object representing the column value - * @see java.sql.ResultSet#getDate(java.lang.String, java.util.Calendar) + * @see java.sql.ResultSet#getDate(int, Calendar) */ - Date getDate(String columnLabel, Calendar cal) throws InvalidResultSetAccessException; + Date getDate(int columnIndex, Calendar cal) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Date object. + * Retrieve the value of the indicated column in the current row + * as a Date object. * @param columnLabel the column label + * @param cal the Calendar to use in constructing the Date * @return a Date object representing the column value - * @see java.sql.ResultSet#getDate(java.lang.String) + * @see java.sql.ResultSet#getDate(String, Calendar) */ - Date getDate(String columnLabel) throws InvalidResultSetAccessException; + Date getDate(String columnLabel, Calendar cal) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Double object. + * Retrieve the value of the indicated column in the current row + * as a Double object. * @param columnIndex the column index * @return a Double object representing the column value * @see java.sql.ResultSet#getDouble(int) @@ -171,17 +171,17 @@ public interface SqlRowSet extends Serializable { double getDouble(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Double object. + * Retrieve the value of the indicated column in the current row + * as a Double object. * @param columnLabel the column label * @return a Double object representing the column value - * @see java.sql.ResultSet#getDouble(java.lang.String) + * @see java.sql.ResultSet#getDouble(String) */ double getDouble(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a float. + * Retrieve the value of the indicated column in the current row + * as a float. * @param columnIndex the column index * @return a float representing the column value * @see java.sql.ResultSet#getFloat(int) @@ -189,17 +189,17 @@ public interface SqlRowSet extends Serializable { float getFloat(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a float. + * Retrieve the value of the indicated column in the current row + * as a float. * @param columnLabel the column label * @return a float representing the column value - * @see java.sql.ResultSet#getFloat(java.lang.String) + * @see java.sql.ResultSet#getFloat(String) */ float getFloat(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * an int. + * Retrieve the value of the indicated column in the current row + * as an int. * @param columnIndex the column index * @return an int representing the column value * @see java.sql.ResultSet#getInt(int) @@ -207,17 +207,17 @@ public interface SqlRowSet extends Serializable { int getInt(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * an int. + * Retrieve the value of the indicated column in the current row + * as an int. * @param columnLabel the column label * @return an int representing the column value - * @see java.sql.ResultSet#getInt(java.lang.String) + * @see java.sql.ResultSet#getInt(String) */ int getInt(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a long. + * Retrieve the value of the indicated column in the current row + * as a long. * @param columnIndex the column index * @return a long representing the column value * @see java.sql.ResultSet#getLong(int) @@ -225,27 +225,37 @@ public interface SqlRowSet extends Serializable { long getLong(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a long. + * Retrieve the value of the indicated column in the current row + * as a long. * @param columnLabel the column label * @return a long representing the column value - * @see java.sql.ResultSet#getLong(java.lang.String) + * @see java.sql.ResultSet#getLong(String) */ long getLong(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * an Object. + * Retrieve the value of the indicated column in the current row + * as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns). * @param columnIndex the column index - * @param map a Map object containing the mapping from SQL types to Java types - * @return a Object representing the column value - * @see java.sql.ResultSet#getObject(int, java.util.Map) + * @return a String representing the column value + * @see java.sql.ResultSet#getNString(int) + * @since 4.1.3 */ - Object getObject(int columnIndex, Map> map) throws InvalidResultSetAccessException; + String getNString(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * an Object. + * Retrieve the value of the indicated column in the current row + * as a String (for NCHAR, NVARCHAR, LONGNVARCHAR columns). + * @param columnLabel the column label + * @return a String representing the column value + * @see java.sql.ResultSet#getNString(String) + * @since 4.1.3 + */ + String getNString(String columnLabel) throws InvalidResultSetAccessException; + + /** + * Retrieve the value of the indicated column in the current row + * as an Object. * @param columnIndex the column index * @return a Object representing the column value * @see java.sql.ResultSet#getObject(int) @@ -253,27 +263,59 @@ public interface SqlRowSet extends Serializable { Object getObject(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * an Object. + * Retrieve the value of the indicated column in the current row + * as an Object. * @param columnLabel the column label + * @return a Object representing the column value + * @see java.sql.ResultSet#getObject(String) + */ + Object getObject(String columnLabel) throws InvalidResultSetAccessException; + + /** + * Retrieve the value of the indicated column in the current row + * as an Object. + * @param columnIndex the column index * @param map a Map object containing the mapping from SQL types to Java types * @return a Object representing the column value - * @see java.sql.ResultSet#getObject(java.lang.String, java.util.Map) + * @see java.sql.ResultSet#getObject(int, Map) + */ + Object getObject(int columnIndex, Map> map) throws InvalidResultSetAccessException; + + /** + * Retrieve the value of the indicated column in the current row + * as an Object. + * @param columnLabel the column label + * @param map a Map object containing the mapping from SQL types to Java types + * @return a Object representing the column value + * @see java.sql.ResultSet#getObject(String, Map) */ Object getObject(String columnLabel, Map> map) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * an Object. + * Retrieve the value of the indicated column in the current row + * as an Object. + * @param columnIndex the column index + * @param type the Java type to convert the designated column to + * @return a Object representing the column value + * @see java.sql.ResultSet#getObject(int) + * @since 4.1.3 + */ + T getObject(int columnIndex, Class type) throws InvalidResultSetAccessException; + + /** + * Retrieve the value of the indicated column in the current row + * as an Object. * @param columnLabel the column label + * @param type the Java type to convert the designated column to * @return a Object representing the column value - * @see java.sql.ResultSet#getObject(java.lang.String) + * @see java.sql.ResultSet#getObject(int) + * @since 4.1.3 */ - Object getObject(String columnLabel) throws InvalidResultSetAccessException; + T getObject(String columnLabel, Class type) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a short. + * Retrieve the value of the indicated column in the current row + * as a short. * @param columnIndex the column index * @return a short representing the column value * @see java.sql.ResultSet#getShort(int) @@ -281,17 +323,17 @@ public interface SqlRowSet extends Serializable { short getShort(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a short. + * Retrieve the value of the indicated column in the current row + * as a short. * @param columnLabel the column label * @return a short representing the column value - * @see java.sql.ResultSet#getShort(java.lang.String) + * @see java.sql.ResultSet#getShort(String) */ short getShort(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a String. + * Retrieve the value of the indicated column in the current row + * as a String. * @param columnIndex the column index * @return a String representing the column value * @see java.sql.ResultSet#getString(int) @@ -299,27 +341,17 @@ public interface SqlRowSet extends Serializable { String getString(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a String. + * Retrieve the value of the indicated column in the current row + * as a String. * @param columnLabel the column label * @return a String representing the column value - * @see java.sql.ResultSet#getString(java.lang.String) + * @see java.sql.ResultSet#getString(String) */ String getString(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Time object. - * @param columnIndex the column index - * @param cal the Calendar to use in constructing the Date - * @return a Time object representing the column value - * @see java.sql.ResultSet#getTime(int, java.util.Calendar) - */ - Time getTime(int columnIndex, Calendar cal) throws InvalidResultSetAccessException; - - /** - * Retrieves the value of the indicated column in the current row as - * a Time object. + * Retrieve the value of the indicated column in the current row + * as a Time object. * @param columnIndex the column index * @return a Time object representing the column value * @see java.sql.ResultSet#getTime(int) @@ -327,37 +359,37 @@ public interface SqlRowSet extends Serializable { Time getTime(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Time object. + * Retrieve the value of the indicated column in the current row + * as a Time object. * @param columnLabel the column label - * @param cal the Calendar to use in constructing the Date * @return a Time object representing the column value - * @see java.sql.ResultSet#getTime(java.lang.String, java.util.Calendar) + * @see java.sql.ResultSet#getTime(String) */ - Time getTime(String columnLabel, Calendar cal) throws InvalidResultSetAccessException; + Time getTime(String columnLabel) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Time object. - * @param columnLabel the column label + * Retrieve the value of the indicated column in the current row + * as a Time object. + * @param columnIndex the column index + * @param cal the Calendar to use in constructing the Date * @return a Time object representing the column value - * @see java.sql.ResultSet#getTime(java.lang.String) + * @see java.sql.ResultSet#getTime(int, Calendar) */ - Time getTime(String columnLabel) throws InvalidResultSetAccessException; + Time getTime(int columnIndex, Calendar cal) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Timestamp object. - * @param columnIndex the column index + * Retrieve the value of the indicated column in the current row + * as a Time object. + * @param columnLabel the column label * @param cal the Calendar to use in constructing the Date - * @return a Timestamp object representing the column value - * @see java.sql.ResultSet#getTimestamp(int, java.util.Calendar) + * @return a Time object representing the column value + * @see java.sql.ResultSet#getTime(String, Calendar) */ - Timestamp getTimestamp(int columnIndex, Calendar cal) throws InvalidResultSetAccessException; + Time getTime(String columnLabel, Calendar cal) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Timestamp object. + * Retrieve the value of the indicated column in the current row + * as a Timestamp object. * @param columnIndex the column index * @return a Timestamp object representing the column value * @see java.sql.ResultSet#getTimestamp(int) @@ -365,123 +397,146 @@ public interface SqlRowSet extends Serializable { Timestamp getTimestamp(int columnIndex) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Timestamp object. + * Retrieve the value of the indicated column in the current row + * as a Timestamp object. * @param columnLabel the column label + * @return a Timestamp object representing the column value + * @see java.sql.ResultSet#getTimestamp(String) + */ + Timestamp getTimestamp(String columnLabel) throws InvalidResultSetAccessException; + + /** + * Retrieve the value of the indicated column in the current row + * as a Timestamp object. + * @param columnIndex the column index * @param cal the Calendar to use in constructing the Date * @return a Timestamp object representing the column value - * @see java.sql.ResultSet#getTimestamp(java.lang.String, java.util.Calendar) + * @see java.sql.ResultSet#getTimestamp(int, Calendar) */ - Timestamp getTimestamp(String columnLabel, Calendar cal) throws InvalidResultSetAccessException; + Timestamp getTimestamp(int columnIndex, Calendar cal) throws InvalidResultSetAccessException; /** - * Retrieves the value of the indicated column in the current row as - * a Timestamp object. + * Retrieve the value of the indicated column in the current row + * as a Timestamp object. * @param columnLabel the column label + * @param cal the Calendar to use in constructing the Date * @return a Timestamp object representing the column value - * @see java.sql.ResultSet#getTimestamp(java.lang.String) + * @see java.sql.ResultSet#getTimestamp(String, Calendar) */ - Timestamp getTimestamp(String columnLabel) throws InvalidResultSetAccessException; + Timestamp getTimestamp(String columnLabel, Calendar cal) throws InvalidResultSetAccessException; // RowSet navigation methods /** - * Moves the cursor to the given row number in the RowSet, just after the last row. + * Move the cursor to the given row number in the row set, + * just after the last row. * @param row the number of the row where the cursor should move - * @return true if the cursor is on the RowSet, false otherwise + * @return {@code true} if the cursor is on the row set, + * {@code false} otherwise * @see java.sql.ResultSet#absolute(int) */ boolean absolute(int row) throws InvalidResultSetAccessException; /** - * Moves the cursor to the end of this RowSet. + * Move the cursor to the end of this row set. * @see java.sql.ResultSet#afterLast() */ void afterLast() throws InvalidResultSetAccessException; /** - * Moves the cursor to the front of this RowSet, just before the first row. + * Move the cursor to the front of this row set, + * just before the first row. * @see java.sql.ResultSet#beforeFirst() */ void beforeFirst() throws InvalidResultSetAccessException; /** - * Moves the cursor to the first row of this RowSet. - * @return true if the cursor is on a valid row, false otherwise + * Move the cursor to the first row of this row set. + * @return {@code true} if the cursor is on a valid row, + * {@code false} otherwise * @see java.sql.ResultSet#first() */ boolean first() throws InvalidResultSetAccessException; /** - * Retrieves the current row number. + * Retrieve the current row number. * @return the current row number * @see java.sql.ResultSet#getRow() */ int getRow() throws InvalidResultSetAccessException; /** - * Retrieves whether the cursor is after the last row of this RowSet. - * @return true if the cursor is after the last row, false otherwise + * Retrieve whether the cursor is after the last row of this row set. + * @return {@code true} if the cursor is after the last row, + * {@code false} otherwise * @see java.sql.ResultSet#isAfterLast() */ boolean isAfterLast() throws InvalidResultSetAccessException; /** - * Retrieves whether the cursor is after the first row of this RowSet. - * @return true if the cursor is after the first row, false otherwise + * Retrieve whether the cursor is before the first row of this row set. + * @return {@code true} if the cursor is before the first row, + * {@code false} otherwise * @see java.sql.ResultSet#isBeforeFirst() */ boolean isBeforeFirst() throws InvalidResultSetAccessException; /** - * Retrieves whether the cursor is on the first row of this RowSet. - * @return true if the cursor is after the first row, false otherwise + * Retrieve whether the cursor is on the first row of this row set. + * @return {@code true} if the cursor is after the first row, + * {@code false} otherwise * @see java.sql.ResultSet#isFirst() */ boolean isFirst() throws InvalidResultSetAccessException; /** - * Retrieves whether the cursor is on the last row of this RowSet. - * @return true if the cursor is after the last row, false otherwise + * Retrieve whether the cursor is on the last row of this row set. + * @return {@code true} if the cursor is after the last row, + * {@code false} otherwise * @see java.sql.ResultSet#isLast() */ boolean isLast() throws InvalidResultSetAccessException; /** - * Moves the cursor to the last row of this RowSet. - * @return true if the cursor is on a valid row, false otherwise + * Move the cursor to the last row of this row set. + * @return {@code true} if the cursor is on a valid row, + * {@code false} otherwise * @see java.sql.ResultSet#last() */ boolean last() throws InvalidResultSetAccessException; /** - * Moves the cursor to the next row. - * @return true if the new row is valid, false if there are no more rows + * Move the cursor to the next row. + * @return {@code true} if the new row is valid, + * {@code false} if there are no more rows * @see java.sql.ResultSet#next() */ boolean next() throws InvalidResultSetAccessException; /** - * Moves the cursor to the previous row. - * @return true if the new row is valid, false if it is off the RowSet + * Move the cursor to the previous row. + * @return {@code true} if the new row is valid, + * {@code false} if it is off the row set * @see java.sql.ResultSet#previous() */ boolean previous() throws InvalidResultSetAccessException; /** - * Moves the cursor a relative number f rows, either positive or negative. - * @return true if the cursor is on a row, false otherwise + * Move the cursor a relative number of rows, + * either positive or negative. + * @return {@code true} if the cursor is on a row, + * {@code false} otherwise * @see java.sql.ResultSet#relative(int) */ boolean relative(int rows) throws InvalidResultSetAccessException; /** - * Reports whether the last column read had a value of SQL {@code NULL}. - * Note that you must first call one of the getter methods and then call - * the {@code wasNull} method. - * @return true if the most recent coumn retrieved was SQL {@code NULL}, - * false otherwise + * Report whether the last column read had a value of SQL {@code NULL}. + *

Note that you must first call one of the getter methods + * and then call the {@code wasNull()} method. + * @return {@code true} if the most recent coumn retrieved was + * SQL {@code NULL}, {@code false} otherwise * @see java.sql.ResultSet#wasNull() */ boolean wasNull() throws InvalidResultSetAccessException;