com.ibatis.sqlmap.client.extensions
Interface ResultGetter

public interface ResultGetter

Allows values to be retrieved from the underlying result set. TypeHandlerCallback implementations use this interface to get values that they can subsequently manipulate before having them returned. Each of these methods has a corresponding method on the ResultSet (or CallableStatement) class, the only difference being that there is no need to specify the column name or index with these methods.

NOTE: There is no need to implement this. The implementation will be passed into the TypeHandlerCallback automatically.

Method Summary

java.sql.Array	getArray() Gets an array from the underlying result set
java.math.BigDecimal	getBigDecimal() Gets a BigDecimal from the underlying result set
java.sql.Blob	getBlob() Gets a Blob from the underlying result set
boolean	getBoolean() Gets a boolean from the underlying result set
byte	getByte() Gets a byte from the underlying result set
byte[]	getBytes() Gets a byte[] from the underlying result set
java.sql.Clob	getClob() Gets a Clob from the underlying result set
int	getColumnIndex() Returns the index of the column being got in the underlying ResultSet.
java.lang.String	getColumnName() Returns the name of the column being got in the underlying ResultSet.
java.sql.Date	getDate() Gets a Date from the underlying result set
java.sql.Date	getDate(java.util.Calendar cal) Gets a Date from the underlying result set using a calendar
double	getDouble() Gets a double from the underlying result set
float	getFloat() Gets a float from the underlying result set
int	getInt() Gets an int from the underlying result set
long	getLong() Gets a long from the underlying result set
java.lang.Object	getObject() Gets an Object from the underlying result set
java.lang.Object	getObject(java.util.Map map) Gets an Object from the underlying result set using a Map
java.sql.Ref	getRef() Gets a Ref from the underlying result set
java.sql.ResultSet	getResultSet() Returns the underlying ResultSet...be careful!
short	getShort() Gets a short from the underlying result set
java.lang.String	getString() Gets a String from the underlying result set
java.sql.Time	getTime() Gets a Time from the underlying result set
java.sql.Time	getTime(java.util.Calendar cal) Gets a Time from the underlying result set using a Calendar
java.sql.Timestamp	getTimestamp() Gets a Timestamp from the underlying result set
java.sql.Timestamp	getTimestamp(java.util.Calendar cal) Gets a Timestamp from the underlying result set
java.net.URL	getURL() Gets a URL from the underlying result set
boolean	wasNull() Tells if the field was null

Method Detail

getArray

public java.sql.Array getArray()
                        throws java.sql.SQLException

Gets an array from the underlying result set

Returns:

- the array

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getBigDecimal

public java.math.BigDecimal getBigDecimal()
                                   throws java.sql.SQLException

Gets a BigDecimal from the underlying result set

Returns:

- the BigDecimal

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getBlob

public java.sql.Blob getBlob()
                      throws java.sql.SQLException

Gets a Blob from the underlying result set

Returns:

- the Blob

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getBoolean

public boolean getBoolean()
                   throws java.sql.SQLException

Gets a boolean from the underlying result set

Returns:

- the boolean

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getByte

public byte getByte()
             throws java.sql.SQLException

Gets a byte from the underlying result set

Returns:

- the byte

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getBytes

public byte[] getBytes()
                throws java.sql.SQLException

Gets a byte[] from the underlying result set

Returns:

- the byte[]

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getClob

public java.sql.Clob getClob()
                      throws java.sql.SQLException

Gets a Clob from the underlying result set

Returns:

- the Clob

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getDate

public java.sql.Date getDate()
                      throws java.sql.SQLException

Gets a Date from the underlying result set

Returns:

- the Date

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getDate

public java.sql.Date getDate(java.util.Calendar cal)
                      throws java.sql.SQLException

Gets a Date from the underlying result set using a calendar

Parameters:

cal - - the Calendar

Returns:

- the Date

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getDouble

public double getDouble()
                 throws java.sql.SQLException

Gets a double from the underlying result set

Returns:

- the double

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getFloat

public float getFloat()
               throws java.sql.SQLException

Gets a float from the underlying result set

Returns:

- the float

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getInt

public int getInt()
           throws java.sql.SQLException

Gets an int from the underlying result set

Returns:

- the int

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getLong

public long getLong()
             throws java.sql.SQLException

Gets a long from the underlying result set

Returns:

- the long

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getObject

public java.lang.Object getObject()
                           throws java.sql.SQLException

Gets an Object from the underlying result set

Returns:

- the Object

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getObject

public java.lang.Object getObject(java.util.Map map)
                           throws java.sql.SQLException

Gets an Object from the underlying result set using a Map

Parameters:

map - - the Map

Returns:

- the Object

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getRef

public java.sql.Ref getRef()
                    throws java.sql.SQLException

Gets a Ref from the underlying result set

Returns:

- the Ref

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getShort

public short getShort()
               throws java.sql.SQLException

Gets a short from the underlying result set

Returns:

- the short

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getString

public java.lang.String getString()
                           throws java.sql.SQLException

Gets a String from the underlying result set

Returns:

- the String

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getTime

public java.sql.Time getTime()
                      throws java.sql.SQLException

Gets a Time from the underlying result set

Returns:

- the Time

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getTime

public java.sql.Time getTime(java.util.Calendar cal)
                      throws java.sql.SQLException

Gets a Time from the underlying result set using a Calendar

Parameters:

cal - - the Calendar

Returns:

- the Time

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getTimestamp

public java.sql.Timestamp getTimestamp()
                                throws java.sql.SQLException

Gets a Timestamp from the underlying result set

Returns:

- the Timestamp

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getTimestamp

public java.sql.Timestamp getTimestamp(java.util.Calendar cal)
                                throws java.sql.SQLException

Gets a Timestamp from the underlying result set

Parameters:

cal - - the Calendar

Returns:

- the Timestamp

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getURL

public java.net.URL getURL()
                    throws java.sql.SQLException

Gets a URL from the underlying result set

Returns:

- the URL

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

wasNull

public boolean wasNull()
                throws java.sql.SQLException

Tells if the field was null

Returns:

- true if it was null

Throws:

java.sql.SQLException - - if the underlying result set throws an exception

getResultSet

public java.sql.ResultSet getResultSet()

Returns the underlying ResultSet...be careful!

Returns:

a ResultSet instance.

getColumnName

public java.lang.String getColumnName()

Returns the name of the column being got in the underlying ResultSet. May be null in which case the getColumnIndex method should be used.

Returns:

the column name (may be null)

getColumnIndex

public int getColumnIndex()

Returns the index of the column being got in the underlying ResultSet. Only use this method if the value returned from getColumnName is null.

Returns:

the index of the column (if zero then use the column name)