com.ibatis.sqlmap.client.extensions
Interface ParameterSetter

All Known Implementing Classes:
ParameterSetterImpl

public interface ParameterSetter

Allows parameters to be set on the underlying prepared statement. TypeHandlerCallback implementations use this interface to process values before they are set on the prepared statement. Each of these methods has a corresponding method on the PreparedStatement class, the only difference being that there is no need to specify the parameter index with these methods.

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


Method Summary
 int getParameterIndex()
          Returns the index of the parameter being set.
 java.sql.PreparedStatement getPreparedStatement()
          Returns the underlying prepared statement...be careful!
 void setArray(java.sql.Array x)
          Set an array on the underlying prepared statement
 void setAsciiStream(java.io.InputStream x, int length)
          Set an InputStream on the underlying prepared statement
 void setBigDecimal(java.math.BigDecimal x)
          Set an on the underlying prepared statement
 void setBinaryStream(java.io.InputStream x, int length)
          Set an InputStream on the underlying prepared statement
 void setBlob(java.sql.Blob x)
          Set a blob on the underlying prepared statement
 void setBoolean(boolean x)
          Set a boolean on the underlying prepared statement
 void setByte(byte x)
          Set a byte on the underlying prepared statement
 void setBytes(byte[] x)
          Set a byte array on the underlying prepared statement
 void setCharacterStream(java.io.Reader reader, int length)
          Set a character stream on the underlying prepared statement
 void setClob(java.sql.Clob x)
          Set a clob on the underlying prepared statement
 void setDate(java.sql.Date x)
          Set a date on the underlying prepared statement
 void setDate(java.sql.Date x, java.util.Calendar cal)
          Set a date with a calendar on the underlying prepared statement
 void setDouble(double x)
          Set a double on the underlying prepared statement
 void setFloat(float x)
          Set a float on the underlying prepared statement
 void setInt(int x)
          Set an integer on the underlying prepared statement
 void setLong(long x)
          Set a long on the underlying prepared statement
 void setNull(int sqlType)
          Set a null on the underlying prepared statement
 void setNull(int sqlType, java.lang.String typeName)
          Set a null on the underlying prepared statement
 void setObject(java.lang.Object x)
          Set an object on the underlying prepared statement
 void setObject(java.lang.Object x, int targetSqlType)
          Set an object on the underlying prepared statement
 void setObject(java.lang.Object x, int targetSqlType, int scale)
          Set an object on the underlying prepared statement
 void setRef(java.sql.Ref x)
          Set a reference on the underlying prepared statement
 void setShort(short x)
          Set a short on the underlying prepared statement
 void setString(java.lang.String x)
          Set a string on the underlying prepared statement
 void setTime(java.sql.Time x)
          Set a time on the underlying prepared statement
 void setTime(java.sql.Time x, java.util.Calendar cal)
          Set a time with a calendar on the underlying prepared statement
 void setTimestamp(java.sql.Timestamp x)
          Set a timestamp on the underlying prepared statement
 void setTimestamp(java.sql.Timestamp x, java.util.Calendar cal)
          Set a timestamp on the underlying prepared statement
 void setURL(java.net.URL x)
          Set a URL on the underlying prepared statement
 

Method Detail

setArray

public void setArray(java.sql.Array x)
              throws java.sql.SQLException
Set an array on the underlying prepared statement

Parameters:
x - - the array to set
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setAsciiStream

public void setAsciiStream(java.io.InputStream x,
                           int length)
                    throws java.sql.SQLException
Set an InputStream on the underlying prepared statement

Parameters:
x - - the InputStream
length - - the length of the InputStream
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setBigDecimal

public void setBigDecimal(java.math.BigDecimal x)
                   throws java.sql.SQLException
Set an on the underlying prepared statement

Parameters:
x -
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setBinaryStream

public void setBinaryStream(java.io.InputStream x,
                            int length)
                     throws java.sql.SQLException
Set an InputStream on the underlying prepared statement

Parameters:
x - - the InputStream
length - - the length of the InputStream
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setBlob

public void setBlob(java.sql.Blob x)
             throws java.sql.SQLException
Set a blob on the underlying prepared statement

Parameters:
x - - the blob
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setBoolean

public void setBoolean(boolean x)
                throws java.sql.SQLException
Set a boolean on the underlying prepared statement

Parameters:
x - - the boolean
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setByte

public void setByte(byte x)
             throws java.sql.SQLException
Set a byte on the underlying prepared statement

Parameters:
x - - the byte
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setBytes

public void setBytes(byte[] x)
              throws java.sql.SQLException
Set a byte array on the underlying prepared statement

Parameters:
x - - the byte[]
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setCharacterStream

public void setCharacterStream(java.io.Reader reader,
                               int length)
                        throws java.sql.SQLException
Set a character stream on the underlying prepared statement

Parameters:
reader - - the reader
length - - the length of the reader
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setClob

public void setClob(java.sql.Clob x)
             throws java.sql.SQLException
Set a clob on the underlying prepared statement

Parameters:
x - - the clob
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setDate

public void setDate(java.sql.Date x)
             throws java.sql.SQLException
Set a date on the underlying prepared statement

Parameters:
x - - the date
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setDate

public void setDate(java.sql.Date x,
                    java.util.Calendar cal)
             throws java.sql.SQLException
Set a date with a calendar on the underlying prepared statement

Parameters:
x - - the date
cal - - the calendar
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setDouble

public void setDouble(double x)
               throws java.sql.SQLException
Set a double on the underlying prepared statement

Parameters:
x - - the double
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setFloat

public void setFloat(float x)
              throws java.sql.SQLException
Set a float on the underlying prepared statement

Parameters:
x - the float
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setInt

public void setInt(int x)
            throws java.sql.SQLException
Set an integer on the underlying prepared statement

Parameters:
x - - the int
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setLong

public void setLong(long x)
             throws java.sql.SQLException
Set a long on the underlying prepared statement

Parameters:
x - - the long
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setNull

public void setNull(int sqlType)
             throws java.sql.SQLException
Set a null on the underlying prepared statement

Parameters:
sqlType - - the type for the null value
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setNull

public void setNull(int sqlType,
                    java.lang.String typeName)
             throws java.sql.SQLException
Set a null on the underlying prepared statement

Parameters:
sqlType - - the type for the null value
typeName - - the name of the type
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setObject

public void setObject(java.lang.Object x)
               throws java.sql.SQLException
Set an object on the underlying prepared statement

Parameters:
x - - the object to set
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setObject

public void setObject(java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException
Set an object on the underlying prepared statement

Parameters:
x - - the object to set
targetSqlType - - the sql type of the object
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setObject

public void setObject(java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.SQLException
Set an object on the underlying prepared statement

Parameters:
x - - the object to set
targetSqlType - - the sql type of the object
scale - - the scale of the object
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setRef

public void setRef(java.sql.Ref x)
            throws java.sql.SQLException
Set a reference on the underlying prepared statement

Parameters:
x - - the reference to set
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setShort

public void setShort(short x)
              throws java.sql.SQLException
Set a short on the underlying prepared statement

Parameters:
x - - the short to set
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setString

public void setString(java.lang.String x)
               throws java.sql.SQLException
Set a string on the underlying prepared statement

Parameters:
x - - the string to set
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setTime

public void setTime(java.sql.Time x)
             throws java.sql.SQLException
Set a time on the underlying prepared statement

Parameters:
x - - the time to set
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setTime

public void setTime(java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.SQLException
Set a time with a calendar on the underlying prepared statement

Parameters:
x - - the time to set
cal - - the calendar to use
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setTimestamp

public void setTimestamp(java.sql.Timestamp x)
                  throws java.sql.SQLException
Set a timestamp on the underlying prepared statement

Parameters:
x - - the timestamp to set
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setTimestamp

public void setTimestamp(java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.SQLException
Set a timestamp on the underlying prepared statement

Parameters:
x - - the timestamp to set
cal - - the calendar to use
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

setURL

public void setURL(java.net.URL x)
            throws java.sql.SQLException
Set a URL on the underlying prepared statement

Parameters:
x - - the url to set
Throws:
java.sql.SQLException - - thrown if the underlying prepared statement throws it

getPreparedStatement

public java.sql.PreparedStatement getPreparedStatement()
Returns the underlying prepared statement...be careful!


getParameterIndex

public int getParameterIndex()
Returns the index of the parameter being set.

Returns:
the parameter index used to set the value in the underlying PreparedStatement