org.josef.jdbc

Interface ResultSetRowInterface

public interface ResultSetRowInterface

Result Set Row Interface.
This interface describes one read-only row read from a result set.

Version:

1.0 $Revision: 5877 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
Array	getArray(int column) Gets the value of the supplied column.
Array	getArray(String columnName) Gets the value of the supplied column.
InputStream	getAsciiStream(int column) Gets the value of the supplied column as a stream of ASCII characters.
InputStream	getAsciiStream(String columnName) Gets the value of the supplied column as a stream of ASCII characters.
BigDecimal	getBigDecimal(int column) Gets the value of the supplied column.
BigDecimal	getBigDecimal(String columnName) Gets the value of the supplied column.
InputStream	getBinaryStream(int column) Gets the value of the supplied column as a stream of uninterpreted bytes.
InputStream	getBinaryStream(String columnName) Gets the value of the supplied column as a stream of uninterpreted bytes.
Blob	getBlob(int column) Gets the value of the supplied column.
Blob	getBlob(String columnName) Gets the value of the supplied column.
Boolean	getBoolean(int column) Gets the value of the supplied column.
Boolean	getBoolean(String columnName) Gets the value of the supplied column.
Byte	getByte(int column) Gets the value of the supplied column.
Byte	getByte(String columnName) Gets the value of the supplied column.
byte[]	getBytes(int column) Gets the value of the supplied column.
byte[]	getBytes(String columnName) Gets the value of the supplied column.
Reader	getCharacterStream(int column) Gets the value of the supplied column as a stream of characters.
Reader	getCharacterStream(String columnName) Gets the value of the supplied column as a stream of characters.
Clob	getClob(int column) Gets the value of the supplied column.
Clob	getClob(String columnName) Gets the value of the supplied column.
Date	getDate(int column) Gets the value of the supplied column.
Date	getDate(int column, Calendar calendar) Gets the value of the supplied column.
Date	getDate(String columnName) Gets the value of the supplied column.
Date	getDate(String columnName, Calendar calendar) Gets the value of the supplied column.
Double	getDouble(int column) Gets the value of the supplied column.
Double	getDouble(String columnName) Gets the value of the supplied column.
Float	getFloat(int column) Gets the value of the supplied column.
Float	getFloat(String columnName) Gets the value of the supplied column.
Integer	getInt(int column) Gets the value of the supplied column.
Integer	getInt(String columnName) Gets the value of the supplied column.
Long	getLong(int column) Gets the value of the supplied column.
Long	getLong(String columnName) Gets the value of the supplied column.
ResultSetMetaData	getMetaData() Retrieves the number, types and properties of this ResultSet object's columns.
Object	getObject(int column) Gets the value of the supplied column.
Object	getObject(String columnName) Gets the value of the supplied column.
Object	getObject(String columnName, Map<String,Class<?>> map) Gets the value of the supplied column.
Ref	getRef(int column) Gets the value of the supplied column.
Ref	getRef(String columnName) Gets the value of the supplied column.
int	getRow() Retrieves the current row number.
Short	getShort(int column) Gets the value of the supplied column.
Short	getShort(String columnName) Gets the value of the supplied column.
String	getString(int column) Gets the value of the supplied column.
String	getString(String columnName) Gets the value of the supplied column.
Time	getTime(int column) Gets the value of the supplied column.
Time	getTime(int column, Calendar calendar) Gets the value of the supplied column.
Time	getTime(String columnName) Gets the value of the supplied column.
Time	getTime(String columnName, Calendar calendar) Gets the value of the supplied column.
Timestamp	getTimestamp(int column) Gets the value of the supplied column.
Timestamp	getTimestamp(int column, Calendar calendar) Gets the value of the supplied column.
Timestamp	getTimestamp(String columnName) Gets the value of the supplied column.
Timestamp	getTimestamp(String columnName, Calendar calendar) Gets the value of the supplied column.
SQLWarning	getWarnings() Retrieves the first warning reported .

Method Detail

getArray

Array getArray(int column)
        throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getArray(int)

getArray

Array getArray(String columnName)
        throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getArray(String)

getAsciiStream

InputStream getAsciiStream(int column)
                    throws SQLException

Gets the value of the supplied column as a stream of ASCII characters.

Parameters:

column - Column index number (starting with 1).

Returns:

An input stream that delivers the database column value as a stream of one-byte ASCII characters or null when the column's value is null.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getAsciiStream(int)

getAsciiStream

InputStream getAsciiStream(String columnName)
                    throws SQLException

Gets the value of the supplied column as a stream of ASCII characters.

Parameters:

columnName - Name of the column.

Returns:

An input stream that delivers the database column value as a stream of one-byte ASCII characters or null when the column value is null.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getAsciiStream(String)

getBigDecimal

BigDecimal getBigDecimal(int column)
                  throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBigDecimal(int)

getBigDecimal

BigDecimal getBigDecimal(String columnName)
                  throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBigDecimal(String)

getBinaryStream

InputStream getBinaryStream(int column)
                     throws SQLException

Gets the value of the supplied column as a stream of uninterpreted bytes.

Parameters:

column - Column index number (starting with 1).

Returns:

An input stream that delivers the database column value as a stream of uninterpreted bytes or null when the column's value is null.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBinaryStream(int)

getBinaryStream

InputStream getBinaryStream(String columnName)
                     throws SQLException

Gets the value of the supplied column as a stream of uninterpreted bytes.

Parameters:

columnName - Name of the column.

Returns:

An input stream that delivers the database column value as a stream of uninterpreted bytes or null when the column's value is null.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBinaryStream(String)

getBlob

Blob getBlob(int column)
      throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBlob(int)

getBlob

Blob getBlob(String columnName)
      throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBlob(String)

getBoolean

Boolean getBoolean(int column)
            throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBoolean(int)

getBoolean

Boolean getBoolean(String columnName)
            throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBoolean(String)

getByte

Byte getByte(int column)
      throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getByte(int)

getByte

Byte getByte(String columnName)
      throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getByte(String)

getBytes

byte[] getBytes(int column)
         throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBytes(int)

getBytes

byte[] getBytes(String columnName)
         throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getBytes(String)

getCharacterStream

Reader getCharacterStream(int column)
                   throws SQLException

Gets the value of the supplied column as a stream of characters.

Parameters:

column - Column index number (starting with 1).

Returns:

An input stream that delivers the database column value as a stream of characters or null when the column's value is null.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getCharacterStream(int)

getCharacterStream

Reader getCharacterStream(String columnName)
                   throws SQLException

Gets the value of the supplied column as a stream of characters.

Parameters:

columnName - Name of the column.

Returns:

An input stream that delivers the database column value as a stream of characters or null when the column's value is null.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getCharacterStream(String)

getClob

Clob getClob(int column)
      throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getClob(int)

getClob

Clob getClob(String columnName)
      throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getClob(String)

getDate

Date getDate(int column)
      throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getDate(int)

getDate

Date getDate(int column,
             Calendar calendar)
      throws SQLException

Gets the value of the supplied column.
This method uses the supplied calendar to construct an appropriate millisecond value for the date if the underlying database does not store timezone information.

Parameters:

column - Column index number (starting with 1).

calendar - Calendar to construct the date.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

NullPointerException - When the supplied calendar is null.

SQLException - When a database access error occurs.

See Also:

ResultSet.getDate(int, Calendar)

getDate

Date getDate(String columnName)
      throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getDate(String)

getDate

Date getDate(String columnName,
             Calendar calendar)
      throws SQLException

Gets the value of the supplied column.
This method uses the supplied calendar to construct an appropriate millisecond value for the date if the underlying database does not store timezone information.

Parameters:

columnName - Name if the column.

calendar - Calendar to construct the date.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

NullPointerException - When the supplied calendar is null.

SQLException - When a database access error occurs.

See Also:

ResultSet.getDate(String, Calendar)

getDouble

Double getDouble(int column)
          throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getDouble(int)

getDouble

Double getDouble(String columnName)
          throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getDouble(String)

getFloat

Float getFloat(int column)
        throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getFloat(int)

getFloat

Float getFloat(String columnName)
        throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getFloat(String)

getInt

Integer getInt(int column)
        throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getInt(int)

getInt

Integer getInt(String columnName)
        throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getInt(String)

getLong

Long getLong(int column)
      throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getLong(int)

getLong

Long getLong(String columnName)
      throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getLong(String)

getMetaData

ResultSetMetaData getMetaData()
                       throws SQLException

Retrieves the number, types and properties of this ResultSet object's columns.

Returns:

The description of this ResultSet object's columns.

Throws:

SQLException - When a database access error occurs.

See Also:

ResultSet.getMetaData()

getObject

Object getObject(int column)
          throws SQLException

Gets the value of the supplied column.
The type of the Java object will be the default Java object type corresponding to the column's SQL type, following the mapping for built-in types specified in the JDBC specification.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getObject(int)

getObject

Object getObject(String columnName)
          throws SQLException

Gets the value of the supplied column.
The type of the Java object will be the default Java object type corresponding to the column's SQL type, following the mapping for built-in types specified in the JDBC specification.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getObject(String)

getObject

Object getObject(String columnName,
                 Map<String,Class<?>> map)
          throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

map - Map object that contains the mapping from SQL type names to classes in the Java programming language.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

NullPointerException - When the supplied map is null.

SQLException - When a database access error occurs.

See Also:

ResultSet.getObject(String, Map)

getRef

Ref getRef(int column)
    throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getRef(int)

getRef

Ref getRef(String columnName)
    throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getRef(String)

getRow

int getRow()
    throws SQLException

Retrieves the current row number.
Rows are numbered starting from 1.

Returns:

The current row number.

Throws:

SQLException - When a database access error occurs.

getShort

Short getShort(int column)
        throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getShort(int)

getShort

Short getShort(String columnName)
        throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getShort(String)

getString

String getString(int column)
          throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getString(int)

getString

String getString(String columnName)
          throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getString(String)

getTime

Time getTime(int column)
      throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getTime(int)

getTime

Time getTime(int column,
             Calendar calendar)
      throws SQLException

Gets the value of the supplied column.
This method uses the supplied calendar to construct an appropriate millisecond value for the time if the underlying database does not store timezone information.

Parameters:

column - Column index number (starting with 1).

calendar - Calendar object to construct the time.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

NullPointerException - When the supplied calendar is null.

SQLException - When a database access error occurs.

See Also:

ResultSet.getTime(int, Calendar)

getTime

Time getTime(String columnName)
      throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getTime(String)

getTime

Time getTime(String columnName,
             Calendar calendar)
      throws SQLException

Gets the value of the supplied column.
This method uses the supplied calendar to construct an appropriate millisecond value for the time if the underlying database does not store timezone information.

Parameters:

columnName - Name of the column.

calendar - Calendar object to construct the time.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

NullPointerException - When the supplied calendar is null.

SQLException - When a database access error occurs.

See Also:

ResultSet.getTime(String, Calendar)

getTimestamp

Timestamp getTimestamp(int column)
                throws SQLException

Gets the value of the supplied column.

Parameters:

column - Column index number (starting with 1).

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

SQLException - When a database access error occurs.

See Also:

ResultSet.getTimestamp(int)

getTimestamp

Timestamp getTimestamp(int column,
                       Calendar calendar)
                throws SQLException

Gets the value of the supplied column.
This method uses the supplied calendar to construct an appropriate millisecond value for the timestamp if the underlying database does not store timezone information.

Parameters:

column - Column index number (starting with 1).

calendar - Calendar object to construct the time.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied column is less than 1.

NullPointerException - When the supplied calendar is null.

SQLException - When a database access error occurs.

See Also:

ResultSet.getTimestamp(int, Calendar)

getTimestamp

Timestamp getTimestamp(String columnName)
                throws SQLException

Gets the value of the supplied column.

Parameters:

columnName - Name of the column.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

SQLException - When a database access error occurs.

See Also:

ResultSet.getTimestamp(String)

getTimestamp

Timestamp getTimestamp(String columnName,
                       Calendar calendar)
                throws SQLException

Gets the value of the supplied column.
This method uses the supplied calendar to construct an appropriate millisecond value for the timestamp if the underlying database does not store timezone information.

Parameters:

columnName - Name of the column.

calendar - Calendar object to construct the time.

Returns:

Value of the column.

Throws:

IllegalArgumentException - When the supplied columnName is null or empty.

NullPointerException - When the supplied calendar is null.

SQLException - When a database access error occurs.

See Also:

ResultSet.getTimestamp(String, Calendar)

getWarnings

SQLWarning getWarnings()
                throws SQLException

Retrieves the first warning reported .

Returns:

The first reported warning or null in the absence of warnings.

Throws:

SQLException - When a database access error occurs.