java.sql

Interface Array

public interface Array

A Java representation of the SQL ARRAY type.

Method Summary

Modifier and Type	Method and Description
void	free() Frees any resources held by this array.
Object	getArray() Retrieves the contents of the SQL ARRAY value as a Java array object.
Object	getArray(long index, int count) Returns part of the SQL ARRAY associated with this array, starting at a particular index and comprising up to count successive elements of the SQL array.
Object	getArray(long index, int count, Map<String,Class<?>> map) Returns part of the SQL ARRAY associated with this array, starting at a particular index and comprising up to count successive elements of the SQL array.
Object	getArray(Map<String,Class<?>> map) Returns the data from the underlying SQL ARRAY as a Java array.
int	getBaseType() Returns the JDBC type of the entries in this array's underlying SQL array.
String	getBaseTypeName() Returns the SQL type name of the entries in this array's underlying SQL array.
ResultSet	getResultSet() Returns a ResultSet object which holds the entries of the SQL ARRAY associated with this array.
ResultSet	getResultSet(long index, int count) Returns a ResultSet object that holds the entries of a subarray, beginning at a particular index and comprising up to count successive entries.
ResultSet	getResultSet(long index, int count, Map<String,Class<?>> map) Returns a ResultSet object that holds the entries of a subarray, beginning at a particular index and comprising up to count successive entries.
ResultSet	getResultSet(Map<String,Class<?>> map) Returns a ResultSet object which holds the entries of the SQL ARRAY associated with this array.

Method Detail

getArray

Object getArray()
         throws SQLException

Retrieves the contents of the SQL ARRAY value as a Java array object.

Returns:

A Java array containing the elements of this Array

Throws:

SQLException - if there is a database error.

getArray

Object getArray(long index,
                int count)
         throws SQLException

Returns part of the SQL ARRAY associated with this array, starting at a particular index and comprising up to count successive elements of the SQL array.

Parameters:

index - the start position in the array where the values are retrieved.

count - the number of elements to retrieve.

Returns:

A Java array containing the desired set of elements from this Array

Throws:

SQLException - if there is a database error.

getArray

Object getArray(long index,
                int count,
                Map<String,Class<?>> map)
         throws SQLException

Returns part of the SQL ARRAY associated with this array, starting at a particular index and comprising up to count successive elements of the SQL array.

Parameters:

index - the start position in the array where the values are retrieved.

count - the number of elements to retrieve.

map - the map defining the correspondence between SQL type names and Java types.

Returns:

A Java array containing the desired set of elements from this Array

Throws:

SQLException - if there is a database error.

getArray

Object getArray(Map<String,Class<?>> map)
         throws SQLException

Returns the data from the underlying SQL ARRAY as a Java array.

Parameters:

map - the map defining the correspondence between SQL type names and Java types.

Returns:

A Java array containing the elements of this array

Throws:

SQLException - if there is a database error.

getBaseType

int getBaseType()
         throws SQLException

Returns the JDBC type of the entries in this array's underlying SQL array.

Returns:

An integer constant from the java.sql.Types class

Throws:

SQLException - if there is a database error.

getBaseTypeName

String getBaseTypeName()
                throws SQLException

Returns the SQL type name of the entries in this array's underlying SQL array.

Returns:

The database specific name or a fully-qualified SQL type name.

Throws:

SQLException - if there is a database error.

getResultSet

ResultSet getResultSet()
                throws SQLException

Returns a ResultSet object which holds the entries of the SQL ARRAY associated with this array.

Returns:

the elements of the array as a ResultSet.

Throws:

SQLException - if there is a database error.

getResultSet

ResultSet getResultSet(long index,
                       int count)
                throws SQLException

Returns a ResultSet object that holds the entries of a subarray, beginning at a particular index and comprising up to count successive entries.

Parameters:

index - the start position in the array where the values are retrieved.

count - the number of elements to retrieve.

Returns:

the elements of the array as a ResultSet.

Throws:

SQLException - if there is a database error.

getResultSet

ResultSet getResultSet(long index,
                       int count,
                       Map<String,Class<?>> map)
                throws SQLException

Returns a ResultSet object that holds the entries of a subarray, beginning at a particular index and comprising up to count successive entries.

Parameters:

index - the start position in the array where the values are retrieved.

count - the number of elements to retrieve.

map - the map defining the correspondence between SQL type names and Java types.

Returns:

the ResultSet the array's custom type values. if a database error has occurred.

Throws:

SQLException - if there is a database error.

getResultSet

ResultSet getResultSet(Map<String,Class<?>> map)
                throws SQLException

Returns a ResultSet object which holds the entries of the SQL ARRAY associated with this array.

Parameters:

map - the map defining the correspondence between SQL type names and Java types.

Returns:

the array as a ResultSet.

Throws:

SQLException - if there is a database error.

free

void free()
   throws SQLException

Frees any resources held by this array. After free is called, calling method other than free will throw SQLException (calling free repeatedly will do nothing).

Throws:

SQLException