getObject Method (int, java.util.Map)

Download JDBC driver

Retrieves the value of the designated parameter as an object in the Java programming language given the parameter index, using the given Map object.

Note

This method is not currently supported by the Microsoft JDBC Driver for SQL Server. Using this method will always return the default mapping.

Syntax

  
public java.lang.Object getObject(int index,  
                                  java.util.Map map)  

Parameters

index

An int that indicates the parameter index.

map

A Map object.

Return Value

An Object value.

Exceptions

SQLServerException

Remarks

This getObject method is specified by the getObject method in the java.sql.CallableStatement interface.

This method will return the value of the given column as a Java object. The type of the Java object will be the default Java object type corresponding to the SQL type of the column, following the mapping for built-in types that is specified in the JDBC specification. If the value is a SQL NULL, the driver returns a Java null.

This method can also be used to read database-specific abstract data types. In the JDBC 2.0 API, the behavior of the getObject method is extended to materialize data of SQL user-defined types. When a column contains a structured or distinct value, the behavior of this method is as if it were a call to getObject(columnIndex, this.getStatement().getConnection().getTypeMap()).

Beginning in the SQL Server JDBC Driver 3.0:

  • A value of type date will be returned as a java.sql.Date object.

  • A value of type time will be returned as a java.sql.Time object.

  • A value of type datetime2 will be returned as a java.sql.Timestamp object.

  • A value of type datetimeoffset will be returned as a microsoft.sql.DateTimeOffset object.

See Also

getObject Method (SQLServerCallableStatement)
SQLServerCallableStatement Members
SQLServerCallableStatement Class