compact2, compact3

java.sql

Interface SQLData

public interface SQLData

用于将SQL用户定义类型（UDT）自定义映射到Java编程语言中的类的接口。 为实现一类的Class对象SQLData界面将在适当的输入Connection对象的类型映射连同它是一个自定义映射的UDT的SQL名称一起。

典型地， SQLData实施将定义一个字段用于为SQL SQL结构类型或单个场的每个属性DISTINCT类型。 当使用ResultSet.getObject方法从数据源检索UDT时，它将被映射为该类的一个实例。 程序员可以像Java编程语言中的任何其他对象一样对该类实例进行操作，然后通过调用PreparedStatement.setObject方法存储对其进行的任何更改，该方法将其映射回SQL类型。

预期自定义映射的类的实现将由一个工具完成。 在典型的实现中，程序员将简单地提供SQL UDT的名称，它被映射到的类的名称以及要映射UDT的每个属性的字段的名称。 该工具将使用此信息来实现SQLData.readSQL和SQLData.writeSQL方法。 readSQL方法调用适当的SQLInput方法从SQLInput对象读取每个属性，并且writeSQL方法调用SQLOutput方法通过SQLOutput对象将每个属性写回数据源。

应用程序员通常不会直接调用SQLData方法，而SQLInput和SQLOutput方法在内部由SQLData方法调用，而不是应用程序代码。

从以下版本开始：

1.2

方法摘要

Modifier and Type	Method and Description
String	getSQLTypeName() 返回此对象表示的SQL用户定义类型的完全限定名称。
void	readSQL(SQLInput stream, String typeName) 使用从数据库读取的数据填充此对象。
void	writeSQL(SQLOutput stream) 将此对象写入给定的SQL数据流，将其转换回数据源中的SQL值。

方法详细信息

getSQLTypeName

String getSQLTypeName()
               throws SQLException

返回此对象表示的SQL用户定义类型的完全限定名称。 此方法由JDBC驱动程序调用，以获取要映射到此实例SQLData的UDT实例的名称。

结果

当构建和填充此对象时，传递给方法 readSQL的类型名称

异常

SQLException - 如果有数据库访问错误

SQLFeatureNotSupportedException - 如果JDBC驱动程序不支持此方法

从以下版本开始：

1.2

readSQL

void readSQL(SQLInput stream,
             String typeName)
      throws SQLException

使用从数据库读取的数据填充此对象。 该方法的实现必须遵循以下协议：

• 它必须从给定的输入流中读取SQL类型的每个属性或元素。 这是通过调用输入流的方法来读取每个项目，按照它们在类型的SQL定义中显示的顺序完成。
• 方法readSQL然后将数据分配给相应的字段或这个或其他对象的元素。 具体而言，它必须调用相应的读取器方法（ SQLInput.readString ， SQLInput.readBigDecimal ，等等）方法（S）执行以下操作：针对不同类型，读取其单个数据元素; 对于结构化类型，读取SQL类型的每个属性的值。

JDBC驱动程序在调用此方法之前使用类型映射程序初始化输入流，由流程中SQLInput读取器方法使用。

参数

stream - SQLInput读取正在自定义映射的值的数据的 SQLInput对象

typeName - 数据流上的值的SQL类型名称

异常

SQLException - 如果有数据库访问错误

SQLFeatureNotSupportedException - 如果JDBC驱动程序不支持此方法

从以下版本开始：

1.2

另请参见：

SQLInput

writeSQL

void writeSQL(SQLOutput stream)
       throws SQLException

将此对象写入给定的SQL数据流，将其转换回数据源中的SQL值。 该方法的实现必须遵循以下协议：
它必须将SQL类型的每个属性写入给定的输出流。 这是通过调用输出流的方法来编写每个项，按照它们在类型的SQL定义中出现的顺序来完成。 具体而言，它必须调用适当SQLOutput作家方法（一个或多个）（ writeInt ， writeString ，等等），以执行以下操作：对的独特的类型，写入其单个数据元素; 对于结构类型，为SQL类型的每个属性写入一个值。

参数

stream - 要为自定义映射的值写入数据的 SQLOutput对象

异常

SQLException - 如果存在数据库访问错误

SQLFeatureNotSupportedException - 如果JDBC驱动程序不支持此方法

从以下版本开始：

1.2

另请参见：

SQLOutput