Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.sql

Interface Array

java.lang.Object
|
+--java.sql.Array


public interface Array

This interface provides methods for accessing SQL array types.

Author:

Method Summary

java.lang.ObjectgetArray()

Returns the contents of this array.
java.lang.ObjectgetArray(java.util.Map map)

Returns the contents of this array.
java.lang.ObjectgetArray(long index, int count)

Returns a portion of this array starting at index into the array and continuing for count elements.
java.lang.ObjectgetArray(long index, int count, java.util.Map map)

This method returns a portion of this array starting at index into the array and continuing for count elements.
intgetBaseType()

Returns the JDBC type identifier of the elements in this array.
java.lang.StringgetBaseTypeName()

Returns the name of the SQL type of the elements in this array.
java.sql.ResultSetgetResultSet()

Returns the elements in the array as a ResultSet.
java.sql.ResultSetgetResultSet(java.util.Map map)

This method returns the elements in the array as a ResultSet.
java.sql.ResultSetgetResultSet(long index, int count)

This method returns a portion of the array as a ResultSet.
java.sql.ResultSetgetResultSet(long index, int count, java.util.Map map)

This method returns a portion of the array as a ResultSet.

Method Details

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:

Throws:


getArray

public Object getArray(java.util.Map map)

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

Parameters:

Returns:

Throws:


getArray

public Object getArray(long index, int count)

Returns a portion of this array starting at index 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:

Returns:

Throws:


getArray

public Object getArray(long index, int count, java.util.Map map)

This method returns a portion of this array starting at index 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:

Returns:

Throws:


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:

Throws:

See Also:


getBaseTypeName

public String getBaseTypeName()

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

Throws:


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:

Throws:

See Also:


getResultSet

public ResultSet getResultSet(java.util.Map 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:

Returns:

Throws:

See Also:


getResultSet

public ResultSet getResultSet(long index, int count)

This method returns a portion of the array as a ResultSet. The returned portion will start at index 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:

Returns:

Throws:

See Also:


getResultSet

public ResultSet getResultSet(long index, int count, java.util.Map map)

This method returns a portion of the array as a ResultSet. The returned portion will start at index 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:

Returns:

Throws:

See Also: