java.sql.SQLInput |
The SQLInput
interface defines operations which apply to a type of
input stream which carries a series of values representing an instance of
an SQL structured type or SQL distinct type.
This interface is used to define custom mappings of SQL User Defined
Types (UDTs) to Java classes. It is used by JDBC drivers, therefore
application programmers do not normally use the SQLInput
methods
directly. Reader methods such as readLong
and readBytes
provide means to read values from an SQLInput
stream.
When the getObject
method is called with an object which implements
the SQLData
interface, the JDBC driver determines the SQL type of the
UDT being mapped by calling the SQLData.getSQLType
method. The driver
creates an instance of an SQLInput
stream, filling the stream with
the attributes of the UDT. The SQLInput
stream is passed to the
SQLData.readSQL
method which then calls the SQLInput
reader
methods to read the attributes.
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns the next attribute in the stream in the form of a
java.sql.Array . | |||||||||||
Returns the next attribute in the stream in the form of an ASCII
character stream embodied as a
java.io.InputStream . | |||||||||||
Returns the next attribute in the stream in the form of a
java.math.BigDecimal . | |||||||||||
Returns the next attribute in the stream in the form of a stream of bytes
embodied as a
java.io.InputStream . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.Blob . | |||||||||||
Returns the next attribute in the stream in the form of a
boolean
. | |||||||||||
Returns the next attribute in the stream in the form of a
byte . | |||||||||||
Returns the next attribute in the stream in the form of a byte array.
| |||||||||||
Returns the next attribute in the stream in the form of a Unicode
character stream embodied as a
java.io.Reader . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.Clob . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.Date . | |||||||||||
Returns the next attribute in the stream in the form of a
double . | |||||||||||
Returns the next attribute in the stream in the form of a
float . | |||||||||||
Returns the next attribute in the stream in the form of an
int . | |||||||||||
Returns the next attribute in the stream in the form of a
long . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.NClob . | |||||||||||
Returns the next attribute in the stream in the form of a
java.lang.String . | |||||||||||
Returns the next attribute in the stream in the form of a
java.lang.Object . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.Ref . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.RowId . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.SQLXML . | |||||||||||
Returns the next attribute in the stream in the form of a
short . | |||||||||||
Returns the next attribute in the stream in the form of a
String . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.Time . | |||||||||||
Returns the next attribute in the stream in the form of a
java.sql.Timestamp . | |||||||||||
Reads the next attribute in the stream (SQL DATALINK value) and returns
it as a
java.net.URL object. | |||||||||||
Reports whether the last value read was SQL
NULL . |
Returns the next attribute in the stream in the form of a java.sql.Array
.
Array
. null
if the value
is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of an ASCII
character stream embodied as a java.io.InputStream
.
java.io.InputStream
. null
if the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.math.BigDecimal
.
java.math.BigDecimal
. null
if
the read returns SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a stream of bytes
embodied as a java.io.InputStream
.
java.io.InputStream
. null
if the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.Blob
.
java.sql.Blob
. null
if
the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a boolean
.
boolean
. false
if the
value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a byte
.
byte
. 0 if the value is SQL
NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a byte array.
null
if the read returns
SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a Unicode
character stream embodied as a java.io.Reader
.
java.io.Reader
. null
if
the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.Clob
.
java.sql.Clob
. null
if
the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.Date
.
java.sql.Date
. null
if
the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a double
.
double
. 0 if the value is SQL
NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a float
.
float
. 0 if the value is SQL
NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of an int
.
int
. 0 if the value is SQL
NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a long
.
long
. 0 if the value is SQL
NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.NClob
.
java.sql.NClob
. null
if
the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.lang.String
. Used for the NCHAR, NVARCHAR and LONGNVARCHAR types.
See readString()
otherwise.
java.lang.String
. null
if
the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.lang.Object
.
The type of the Object
returned is determined by the type mapping
for this JDBC driver, including any customized mappings, if present. A
type map is given to the SQLInput
by the JDBC driver before the
SQLInput
is given to the application.
If the attribute is an SQL structured or distinct type, its SQL type is
determined. If the stream's type map contains an element for that SQL
type, the driver creates an object for the relevant type and invokes the
method SQLData.readSQL
on it, which reads supplementary data from
the stream using whichever protocol is defined for that method.
null
if the value is SQL
NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.Ref
.
java.sql.Ref
. null
if the
value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.RowId
. Used for the ROWID type.
java.sql.RowId
. null
if
the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.SQLXML
.
java.sql.SQLXML
. null
if
the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a short
.
short
. 0 if the value is SQL
NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a String
.
null
if the value is SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.Time
.
java.sql.Time
. null
if the
read returns SQL NULL
.SQLException | if there is a database error. |
---|
Returns the next attribute in the stream in the form of a java.sql.Timestamp
.
java.sql.Timestamp
. null
if
the read returns SQL NULL
.SQLException | if there is a database error. |
---|
Reads the next attribute in the stream (SQL DATALINK value) and returns
it as a java.net.URL
object.
java.net.URL
. null
if the
value is SQL NULL
.SQLException | if there is a database error. |
---|
Reports whether the last value read was SQL NULL
.
true
if the last value read was SQL NULL
, false
otherwise.SQLException | if there is a database error. |
---|