public interface Array
java.sql.Array |
Java编程语言中用于SQL类型ARRAY
。 默认情况下, Array
值是对SQL ARRAY
值的事务持续时间引用。 默认情况下, Array
对象在内部使用SQL LOCATOR(数组),这意味着Array
对象包含一个指向SQL ARRAY
值中数据的逻辑指针,而不包含ARRAY
值的数据。
Array
接口提供了将值ARRAY
的数据作为数组或ResultSet
对象提供给客户端的ResultSet
。 如果SQL ARRAY
的元素是UDT,则可能会自定义映射。 要创建自定义映射,程序员必须做两件事:
SQLData
interface for the UDT to be custom mapped. Class
object for the class implementing SQLData
当包含基类型条目的类型映射被提供给方法getArray
和getResultSet
,它包含的映射将用于映射ARRAY
值的元素。 如果没有提供类型映射(通常情况下是这种情况),则默认使用连接的类型映射。 如果提供给方法的连接的类型映射或类型映射没有基类型的条目,则根据标准映射映射元素。
如果JDBC驱动程序支持数据类型,则必须完全实现 Array
接口上的所有方法。
Public methods |
|
---|---|
abstract void |
free() 这个方法释放了 |
abstract Object |
getArray(Map<String, Class<?>> map) 检索此 |
abstract Object |
getArray() 以Java编程语言中数组的形式检索此 |
abstract Object |
getArray(long index, int count, Map<String, Class<?>> map) 从指定的 |
abstract Object |
getArray(long index, int count) 从指定的 |
abstract int |
getBaseType() 检索由此 |
abstract String |
getBaseTypeName() 检索由此 |
abstract ResultSet |
getResultSet() 检索包含此 |
abstract ResultSet |
getResultSet(Map<String, Class<?>> map) 检索包含此 |
abstract ResultSet |
getResultSet(long index, int count, Map<String, Class<?>> map) 检索包含从索引 |
abstract ResultSet |
getResultSet(long index, int count) 检索包含从索引 |
void free ()
这种方法释放了Array
对象并释放它拥有的资源。 一旦调用free
方法,该对象就无效。
在free
之后,任何尝试调用除free
以外的方法free
将导致SQLException
被抛出。 如果free
被多次调用,在后续调用free
被视为无操作。
Throws | |
---|---|
SQLException |
if an error occurs releasing the Array's resources |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
Object getArray (Map<String, Class<?>> map)
检索此Array
对象指定的SQL ARRAY
值的内容。 此方法使用指定的map
进行类型映射自定义,除非该数组的基类型与map
中的用户定义类型不匹配,在这种情况下,它将使用标准映射。 该版本的方法getArray
使用给定的类型映射或标准映射; 它从不使用与连接关联的类型映射。
注意:当使用 getArray
实现映射到基元数据类型的基本类型时,它是实现定义的,无论返回的数组是否是该基元数据类型的数组或 Object
的数组。
Parameters | |
---|---|
map |
Map : a java.util.Map object that contains mappings of SQL type names to classes in the Java programming language |
Returns | |
---|---|
Object |
an array in the Java programming language that contains the ordered elements of the SQL array designated by this object |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the array |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
Object getArray ()
以Java编程语言中数组的形式检索此Array
对象指定的SQL ARRAY
值的内容。 该版本的方法getArray
使用与连接关联的类型映射来定制类型映射。
注意:当使用 getArray
实现映射到基元数据类型的基本类型时,它是由实现定义的,无论返回的数组是否是该基元数据类型的数组或 Object
的数组。
Returns | |
---|---|
Object |
an array in the Java programming language that contains the ordered elements of the SQL ARRAY value designated by this Array object |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the array |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
Object getArray (long index, int count, Map<String, Class<?>> map)
从指定的 index
开始,包含多达 count
连续的SQL数组元素,从此 Array
对象中指定的SQL ARRAY
值的 Array
进行 count
。
此方法使用指定的map
进行类型映射自定义,除非阵列的基本类型与map
中的用户定义类型不匹配,在这种情况下,它会使用标准映射。 该版本的方法getArray
使用给定的类型映射或标准映射; 它从不使用与连接关联的类型映射。
注意:当使用 getArray
实现映射到基元数据类型的基本类型时,则无论返回的数组是否为该基元数据类型的数组或 Object
的数组,它都是实现定义的。
Parameters | |
---|---|
index |
long : the array index of the first element to retrieve; the first element is at index 1 |
count |
int : the number of successive SQL array elements to retrieve |
map |
Map : a java.util.Map object that contains SQL type names and the classes in the Java programming language to which they are mapped |
Returns | |
---|---|
Object |
an array containing up to count consecutive elements of the SQL ARRAY value designated by this Array object, beginning with element index |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the array |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
Object getArray (long index, int count)
从指定的index
开始,检索由此Array
对象指定的SQL ARRAY
值的Array
,并且包含最多count
个SQL数组的连续元素。 此方法使用与连接关联的类型映射来定制类型映射。
注意:当使用 getArray
实现映射到基本数据类型的基本类型时,它是实现定义的,无论返回的数组是否为该基本数据类型的数组或 Object
的数组。
Parameters | |
---|---|
index |
long : the array index of the first element to retrieve; the first element is at index 1 |
count |
int : the number of successive SQL array elements to retrieve |
Returns | |
---|---|
Object |
an array containing up to count consecutive elements of the SQL array, beginning with element index |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the array |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
int getBaseType ()
检索由此 Array
对象指定的数组中元素的JDBC类型。
Returns | |
---|---|
int |
a constant from the class Types that is the type code for the elements in the array designated by this Array object |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the base type |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
String getBaseTypeName ()
检索由此Array
对象指定的数组中元素的SQL类型名称。 如果元素是内置类型,它将返回元素的特定于数据库的类型名称。 如果元素是用户定义类型(UDT),则此方法返回完全限定的SQL类型名称。
Returns | |
---|---|
String |
a String that is the database-specific name for a built-in base type; or the fully-qualified SQL type name for a base type that is a UDT |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the type name |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
ResultSet getResultSet ()
检索包含此Array
对象指定的SQL ARRAY
值元素的结果集。 如果适当,数组的元素使用连接的类型映射映射; 否则,使用标准映射。
结果集包含每个数组元素的一行,每行包含两列。 第二列存储元素值; 第一列将索引存储到该元素的数组中(第一个数组元素位于索引1处)。 行按照索引的顺序升序排列。
Returns | |
---|---|
ResultSet |
a ResultSet object containing one row for each of the elements in the array designated by this Array object, with the rows in ascending order based on the indices. |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the array |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
ResultSet getResultSet (Map<String, Class<?>> map)
检索包含此Array
对象指定的SQL ARRAY
值元素的结果集。 此方法使用指定的map
进行类型映射自定义,除非该数组的基本类型与map
中的用户定义类型不匹配,在这种情况下,它将使用标准映射。 该版本的方法getResultSet
使用给定的类型映射或标准映射; 它从不使用与连接关联的类型映射。
结果集包含每个数组元素的一行,每行包含两列。 第二列存储元素值; 第一列将索引存储到该元素的数组中(第一个数组元素位于索引1处)。 行按照索引的顺序升序排列。
Parameters | |
---|---|
map |
Map : contains the mapping of SQL user-defined types to classes in the Java programming language |
Returns | |
---|---|
ResultSet |
a ResultSet object containing one row for each of the elements in the array designated by this Array object, with the rows in ascending order based on the indices. |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the array |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
ResultSet getResultSet (long index, int count, Map<String, Class<?>> map)
检索包含从索引index
开始并包含最多count
连续元素的子index
的元素的结果集。 此方法使用指定的map
进行类型映射自定义,除非该数组的基本类型与map
中的用户定义类型不匹配,在这种情况下,它将使用标准映射。 该版本的方法getResultSet
使用给定的类型映射或标准映射; 它从不使用与连接关联的类型映射。
结果集对于此对象指定的SQL数组的每个元素都有一行,第一行包含索引为index
的元素。 结果集最多可以count
行按索引升序排列。 每行有两列:第二列存储元素值; 第一列将索引索引到该元素的数组中。
Parameters | |
---|---|
index |
long : the array index of the first element to retrieve; the first element is at index 1 |
count |
int : the number of successive SQL array elements to retrieve |
map |
Map : the Map object that contains the mapping of SQL type names to classes in the Java(tm) programming language |
Returns | |
---|---|
ResultSet |
a ResultSet object containing up to count consecutive elements of the SQL array designated by this Array object, starting at index index . |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the array |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
ResultSet getResultSet (long index, int count)
检索包含从索引index
开始并包含最多count
连续元素的子index
的元素的结果集。 如果地图包含基本类型的条目,则此方法使用连接的类型映射映射数组的元素。 否则,使用标准映射。
结果集对于此对象指定的SQL数组的每个元素都有一行,第一行包含索引为index
的元素。 结果集根据索引以升序排列最多count
行。 每行有两列:第二列存储元素值; 第一列将索引存储到该元素的数组中。
Parameters | |
---|---|
index |
long : the array index of the first element to retrieve; the first element is at index 1 |
count |
int : the number of successive SQL array elements to retrieve |
Returns | |
---|---|
ResultSet |
a ResultSet object containing up to count consecutive elements of the SQL array designated by this Array object, starting at index index . |
Throws | |
---|---|
SQLException |
if an error occurs while attempting to access the array |
SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |