|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
The mapping in the Java programming language for the SQL type
ARRAY.
By default, an Array object is a transaction-duration
reference to an SQL ARRAY value. By default, an Array
object is implemented using an SQL LOCATOR(array) internally, which
means that an Array object contains a logical pointer
to the data in the SQL ARRAY value on the server rather
than containing the ARRAY value's data.
The Array interface provides methods for bringing an SQL
ARRAY value's data to the client as either an array or a
ResultSet object.
If the elements of the SQL ARRAY
are a UDT, they may be custom mapped. To create a custom mapping,
a programmer must do two things:
SQLData
interface for the UDT to be custom mapped. This will typically be
done using a tool.
Class object for the class implementing
SQLData
When a type map with an entry for
the base type is supplied to the methods getArray
and getResultSet, the mapping
it contains will be used to map the elements of the ARRAY value.
If no type map is supplied, which would typically be the case,
the connection's type map is used by default.
If the connection's type map or a type map supplied to a method has no entry
for the base type, the elements are mapped according to the standard mapping.
NOTE: This interface is new in the JDBC 2.0 API.
| Method Summary | |
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)
Returns an array containing 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)
Returns an array containing a slice of the SQL array object 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 the contents of the SQL array designated by this Array object. |
int |
getBaseType()
Returns the JDBC type of the elements in the array designated by this Array object. |
String |
getBaseTypeName()
Returns the SQL type name of the elements in the array designated by this Array object. |
ResultSet |
getResultSet()
Returns a result set that contains the elements of the SQL ARRAY value
designated by this Array object. |
ResultSet |
getResultSet(long index,
int count)
Returns 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)
Returns 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)
Returns a result set that contains the elements of the SQL ARRAY value
designated by this Array object. |
| Method Detail |
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.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 UDTSQLException - if an error occurs while attempting
to access the type name
public int getBaseType()
throws SQLException
Array object.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 type
public 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.ARRAY value
designated by this objectSQLException - if an error occurs while attempting to
access the array
public Object getArray(Map map)
throws SQLException
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
getArray uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.map - a java.util.Map object that contains mappings
of SQL type names to classes in the Java programming languageSQLException - if an error occurs while attempting to
access the array
public 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.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 retrievecount consecutive elements
of the SQL array, beginning with element indexSQLException - if an error occurs while attempting to
access the array
public Object getArray(long index,
int count,
Map map)
throws SQLException
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.
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 mappedcount
consecutive elements of the SQL array designated by this
Array object, beginning with element
index.SQLException - if an error occurs while attempting to
access the array
public ResultSet getResultSet()
throws SQLException
ARRAY value
designated by this Array 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.
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 array
public 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.
map - contains the mapping of SQL user-defined types to
classes in the Java programming languageResultSet 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 array
public 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.
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 retrieveResultSet 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
public 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.
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 languageResultSet 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
|
JavaTM 2 Platform Std. Ed. v1.3.1 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Java, Java 2D, and JDBC are trademarks or registered trademarks of Oracle and/or its affiliates, in the US and other countries.
Copyright © 1995, 2010 Oracle and/or its affiliates. All rights reserved.