|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.as400.access.AS400JDBCArray
public class AS400JDBCArray
AS400JDBCArray is an implementation of java.sql.Array and contains an array of JDBC data.
It provides mapping in the Java programming language for the SQL type ARRAY
.
Currently AS400JDBCArray is only supported by using stored procedure input/output parameters.
Method Summary | |
---|---|
void |
free()
This method will free the internal memory that this object holds. |
Object |
getArray()
Retrieves the contents of the SQL ARRAY value designated
by this Array object in the form of an array in the Java
programming language. |
Object |
getArray(long index,
int count)
Retrieves a slice of the SQL ARRAY value designated by
this Array object, beginning with the specified
index and containing up to count successive
elements of the SQL array. |
Object |
getArray(long index,
int count,
Map map)
Retreives a slice of the SQL ARRAY value designated by
this Array object, beginning with the specified
index and containing up to count successive
elements of the SQL array. |
Object |
getArray(Map map)
Retrieves a result set that contains the elements of the SQL ARRAY value designated by this Array
object. |
int |
getBaseType()
Retrieves the JDBC type of the elements in the array designated by this Array object. |
String |
getBaseTypeName()
Retrieves the SQL type name of the elements in the array designated by this Array object. |
ResultSet |
getResultSet()
Retrieves Array ResultSet that contains the elements of the SQL ARRAY value designated by this Array
object. |
ResultSet |
getResultSet(long index,
int count)
Retrieves a result set holding the elements of the subarray that starts at index index and contains up to count
successive elements. |
ResultSet |
getResultSet(long index,
int count,
Map map)
Retrieves a result set holding the elements of the subarray that starts at index index and contains up to count
successive elements. |
ResultSet |
getResultSet(Map map)
Retrieves a result set that contains the elements of the SQL ARRAY value designated by this Array
object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void free() throws SQLException
free
in interface Array
SQLException
public String getBaseTypeName() throws SQLException
Array
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.
getBaseTypeName
in interface Array
SQLException
- if an error occurs while attempting to access the type
namepublic int getBaseType() throws SQLException
Array
object.
getBaseType
in interface Array
Types
that is the type
code for the elements in the array designated by this
Array
object
SQLException
- if an error occurs while attempting to access the base
typepublic Object getArray() throws SQLException
ARRAY
value designated
by this Array
object in the form of an array in the Java
programming language. This version of the method getArray
uses the type map associated with the connection for customizations of
the type mappings.
getArray
in interface Array
ARRAY
value designated
by this Array
object
SQLException
- if an error occurs while attempting to access the arraypublic Object getArray(long index, int count) throws SQLException
ARRAY
value designated by
this Array
object, beginning with the specified
index
and containing up to count
successive
elements of the SQL array. This method uses the type map associated with
the connection for customizations of the type mappings.
getArray
in interface Array
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
count
consecutive
elements of the SQL array, beginning with element
index
SQLException
- if an error occurs while attempting to access the arraypublic ResultSet getResultSet() throws SQLException
ARRAY
value designated by this Array
object.
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.
getResultSet
in interface Array
Array
object, with the rows in ascending order based on the indices.
SQLException
- if an error occurs while attempting to access the arraypublic ResultSet getResultSet(long index, int count) throws SQLException
index
and contains up to count
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 index
index
. The result set has up to count
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.
getResultSet
in interface Array
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
ResultSet
object containing up to
count
consecutive elements of the SQL array
designated by this Array
object, starting at index
index
.
SQLException
- if an error occurs while attempting to access the arraypublic Object getArray(Map map) throws SQLException
ARRAY
value designated by this Array
object. This method uses the specified map
for type map
customizations unless the base type of the array does not match a
user-defined type in map
, in which case it uses the
standard mapping. This version of the method getResultSet
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.
getArray
in interface Array
map
- contains the mapping of SQL user-defined types to classes in
the Java programming language
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.
SQLException
- if an error occurs while attempting to access the arraypublic Object getArray(long index, int count, Map map) throws SQLException
ARRAY
value designated by
this Array
object, beginning with the specified
index
and containing up to count
successive
elements of the SQL array.
This method uses the specified map
for type map
customizations unless the base type of the array does not match a
user-defined type in map
, in which case it uses the
standard mapping. This version of the method getArray
uses
either the given type map or the standard mapping; it never uses the type
map associated with the connection.
getArray
in interface Array
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
- a java.util.Map
object that contains SQL type
names and the classes in the Java programming language to
which they are mapped
count
consecutive
elements of the SQL ARRAY
value designated by this
Array
object, beginning with element
index
SQLException
- if an error occurs while attempting to access the arraypublic ResultSet getResultSet(Map map) throws SQLException
ARRAY
value designated by this Array
object. This method uses the specified map
for type map
customizations unless the base type of the array does not match a
user-defined type in map
, in which case it uses the
standard mapping. This version of the method getResultSet
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.
getResultSet
in interface Array
map
- contains the mapping of SQL user-defined types to classes in
the Java programming language
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.
SQLException
- if an error occurs while attempting to access the arraypublic ResultSet getResultSet(long index, int count, Map map) throws SQLException
index
and contains up to count
successive elements. This method uses the specified map
for type map customizations unless the base type of the array does not
match a user-defined type in map
, in which case it uses
the standard mapping. This version of the method
getResultSet
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 index
index
. The result set has up to count
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.
getResultSet
in interface Array
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
- the Map
object that contains the mapping of SQL
type names to classes in the Java(tm) programming language
ResultSet
object containing up to
count
consecutive elements of the SQL array
designated by this Array
object, starting at index
index
.
SQLException
- if an error occurs while attempting to access the array
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |