java.sql

Interface Array

public interface Array

This interface provides methods for accessing SQL array types.

Method Summary
Object	getArray() Returns the contents of this array.
Object	getArray(Map<String,Class<?>> map) Returns the contents of this array.
Object	getArray(long start, int count) Returns a portion of this array starting at `start` into the array and continuing for `count` elements.
Object	getArray(long start, int count, Map<String,Class<?>> map) This method returns a portion of this array starting at `start` into the array and continuing for `count` elements.
int	getBaseType() Returns the JDBC type identifier of the elements in this array.
String	getBaseTypeName() Returns the name of the SQL type of the elements in this array.
ResultSet	getResultSet() Returns the elements in the array as a `ResultSet`.
ResultSet	getResultSet(Map<String,Class<?>> map) This method returns the elements in the array as a `ResultSet`.
ResultSet	getResultSet(long start, int count) This method returns a portion of the array as a `ResultSet`.
ResultSet	getResultSet(long start, int count, Map<String,Class<?>> map) This method returns a portion of the array as a `ResultSet`.

Method Detail

getArray

public Object getArray()

Returns the contents of this array. This object returned will be an array of Java objects of the appropriate types.

Returns: The contents of the array as an array of Java objects.

Throws: SQLException If an error occurs.

getArray

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

Returns the contents of this array. The specified Map will be used to override selected mappings between SQL types and Java classes.

Parameters: map A mapping of SQL types to Java classes.

Returns: The contents of the array as an array of Java objects.

Throws: SQLException If an error occurs.

getArray

public Object getArray(long start, int count)

Returns a portion of this array starting at start into the array and continuing for count elements. Fewer than the requested number of elements will be returned if the array does not contain the requested number of elements. The object returned will be an array of Java objects of the appropriate types.

Parameters: start The offset into this array to start returning elements from. count The requested number of elements to return.

Returns: The requested portion of the array.

Throws: SQLException If an error occurs.

getArray

public Object getArray(long start, int count, Map<String,Class<?>> map)

This method returns a portion of this array starting at start into the array and continuing for count elements. Fewer than the requested number of elements will be returned if the array does not contain the requested number of elements. The object returned will be an array of Java objects. The specified Map will be used for overriding selected SQL type to Java class mappings.

Parameters: start The offset into this array to start returning elements from. count The requested number of elements to return. map A mapping of SQL types to Java classes.

Returns: The requested portion of the array.

Throws: SQLException If an error occurs.

getBaseType

public int getBaseType()

Returns the JDBC type identifier of the elements in this array. This will be one of the values defined in the Types class.

Returns: The JDBC type of the elements in this array.

Throws: SQLException If an error occurs.

getBaseTypeName

public String getBaseTypeName()

Returns the name of the SQL type of the elements in this array. This name is database specific.

Returns: The name of the SQL type of the elements in this array.

Throws: SQLException If an error occurs.

getResultSet

public ResultSet getResultSet()

Returns the elements in the array as a ResultSet. Each row of the result set will have two columns. The first will be the index into the array of that row's contents. The second will be the actual value of that array element.

Returns: The elements of this array as a ResultSet.

Throws: SQLException If an error occurs.

See Also: ResultSet

getResultSet

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

This method returns the elements in the array as a ResultSet. Each row of the result set will have two columns. The first will be the index into the array of that row's contents. The second will be the actual value of that array element. The specified Map will be used to override selected default mappings of SQL types to Java classes.

Parameters: map A mapping of SQL types to Java classes.

Returns: The elements of this array as a ResultSet.

Throws: SQLException If an error occurs.

See Also: ResultSet

getResultSet

public ResultSet getResultSet(long start, int count)

This method returns a portion of the array as a ResultSet. The returned portion will start at start into the array and up to count elements will be returned.

Each row of the result set will have two columns. The first will be the index into the array of that row's contents. The second will be the actual value of that array element.

Parameters: start The index into the array to start returning elements from. count The requested number of elements to return.

Returns: The requested elements of this array as a ResultSet.

Throws: SQLException If an error occurs.

See Also: ResultSet

getResultSet

public ResultSet getResultSet(long start, int count, Map<String,Class<?>> map)

This method returns a portion of the array as a ResultSet. The returned portion will start at start into the array and up to count elements will be returned.

Each row of the result set will have two columns. The first will be the index into the array of that row's contents. The second will be the actual value of that array element. The specified Map will be used to override selected default mappings of SQL types to Java classes.

Parameters: start The index into the array to start returning elements from. count The requested number of elements to return. map A mapping of SQL types to Java classes.

Returns: The requested elements of this array as a ResultSet.

Throws: SQLException If an error occurs.

See Also: ResultSet