Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.firebirdsql.jdbc.FBArray
public class FBArray
extends java.lang.Object
implements Array
java.sql.Array
Method Summary | |
Object |
|
Object |
|
Object |
|
Object |
|
int |
|
String |
|
ResultSet |
|
ResultSet |
|
ResultSet |
|
ResultSet |
|
public Object getArray() throws SQLException
Retrieves the contents of the SQLARRAY
value designated by thisArray
object in the form of an array in the Java programming language. This version of the methodgetArray
uses the type map associated with the connection for customizations of the type mappings.
- Returns:
- an array in the Java programming language that contains the ordered elements of the SQL
ARRAY
value designated by this object
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public Object getArray(Map map) throws SQLException
Retrieves the contents of the SQL array designated by thisArray
object. This method uses the specifiedmap
for type map customizations unless the base type of the array does not match a user-defined type inmap
, in which case it uses the standard mapping. This version of the methodgetArray
uses either the given type map or the standard mapping; it never uses the type map associated with the connection.
- Parameters:
map
- ajava.util.Map
object that contains mappings of SQL type names to classes in the Java programming language
- Returns:
- an array in the Java programming language that contains the ordered elements of the SQL array designated by this object
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public Object getArray(long index, int count) throws SQLException
Returns an array containing a slice of the SQLARRAY
value designated by thisArray
object, beginning with the specifiedindex
and containing up tocount
successive elements of the SQL array. This method uses the type map associated with the connection for customizations of the type mappings.
- Parameters:
index
- the array index of the first element to retrieve; the first element is at index 1count
- the number of successive SQL array elements to retrieve
- Returns:
- an array containing up to
count
consecutive elements of the SQL array, beginning with elementindex
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public Object getArray(long index, int count, Map map) throws SQLException
Returns an array containing a slice of the SQL array object designated by thisArray
object, beginning with the specifiedindex
and containing up tocount
successive elements of the SQL array. This method uses the specifiedmap
for type map customizations unless the base type of the array does not match a user-defined type inmap
, in which case it uses the standard mapping. This version of the methodgetArray
uses either the given type map or the standard mapping; it never uses the type map associated with the connection.
- Parameters:
index
- the array index of the first element to retrieve; the first element is at index 1count
- the number of successive SQL array elements to retrievemap
- ajava.util.Map
object that contains SQL type names and the classes in the Java programming language to which they are mapped
- Returns:
- an array containing up to
count
consecutive elements of the SQL array designated by thisArray
object, beginning with elementindex
.
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public int getBaseType() throws SQLException
Returns the JDBC type of the elements in the array designated by thisArray
object.
- Returns:
- a constant from the class
java.sql.Types
that is the type code for the elements in the array designated by thisArray
object.
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public String getBaseTypeName() throws SQLException
Returns the SQL type name of the elements in the array designated by thisArray
object. If the elements are a built-in type, it returns the database-specific type name of the elements. If the elements are a user-defined type (UDT), this method returns the fully-qualified SQL type name.
- Returns:
- 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
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public ResultSet getResultSet() throws SQLException
Returns a result set that contains the elements of the SQLARRAY
value designated by thisArray
object. If appropriate, the elements of the array are mapped using the connection's type map; otherwise, the standard mapping is used. The result set contains one row for each array element, with two columns in each row. The second column stores the element value; the first column stores the index into the array for that element (with the first array element being at index 1). The rows are in ascending order corresponding to the order of the indices.
- Returns:
- a
ResultSet
object containing one row for each of the elements in the array designated by thisArray
object, with the rows in ascending order based on the indices.
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public ResultSet getResultSet(Map map) throws SQLException
Returns a result set that contains the elements of the SQLARRAY
value designated by thisArray
object. This method uses the specifiedmap
for type map customizations unless the base type of the array does not match a user-defined type inmap
, in which case it uses the standard mapping. This version of the methodgetResultSet
uses either the given type map or the standard mapping; it never uses the type map associated with the connection. The result set contains one row for each array element, with two columns in each row. The second column stores the element value; the first column stores the index into the array for that element (with the first array element being at index 1). The rows are in ascending order corresponding to the order of the indices.
- Parameters:
map
- contains the mapping of SQL user-defined types to classes in the Java programming language
- Returns:
- a
ResultSet
object containing one row for each of the elements in the array designated by thisArray
object, with the rows in ascending order based on the indices.
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public ResultSet getResultSet(long index, int count) throws SQLException
Returns a result set holding the elements of the subarray that starts at indexindex
and contains up tocount
successive elements. This method uses the connection's type map to map the elements of the array if the map contains an entry for the base type. Otherwise, the standard mapping is used. The result set has one row for each element of the SQL array designated by this object, with the first row containing the element at indexindex
. The result set has up tocount
rows in ascending order based on the indices. Each row has two columns: The second column stores the element value; the first column stores the index into the array for that element.
- Parameters:
index
- the array index of the first element to retrieve; the first element is at index 1count
- the number of successive SQL array elements to retrieve
- Returns:
- a
ResultSet
object containing up tocount
consecutive elements of the SQL array designated by thisArray
object, starting at indexindex
.
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API
public ResultSet getResultSet(long index, int count, Map map) throws SQLException
Returns a result set holding the elements of the subarray that starts at indexindex
and contains up tocount
successive elements. This method uses the specifiedmap
for type map customizations unless the base type of the array does not match a user-defined type inmap
, in which case it uses the standard mapping. This version of the methodgetResultSet
uses either the given type map or the standard mapping; it never uses the type map associated with the connection. The result set has one row for each element of the SQL array designated by this object, with the first row containing the element at indexindex
. The result set has up tocount
rows in ascending order based on the indices. Each row has two columns: The second column stores the element value; the first column stroes the index into the array for that element.
- Parameters:
index
- the array index of the first element to retrieve; the first element is at index 1count
- the number of successive SQL array elements to retrievemap
- theMap
object that contains the mapping of SQL type names to classes in the Java(tm) programming language
- Returns:
- a
ResultSet
object containing up tocount
consecutive elements of the SQL array designated by thisArray
object, starting at indexindex
.
- Since:
- 1.2
- See Also:
What Is in the JDBC 2.0 API