Save This Page
Home » openjdk-7 » java » sql » [javadoc | source]
java.sql
public interface: Array [javadoc | source]

All Known Implementing Classes:
    SerialArray

The mapping in the Java programming language for the SQL type ARRAY. By default, an Array value 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 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:

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.

All methods on the Array interface must be fully implemented if the JDBC driver supports the data type.

Method from java.sql.Array Summary:
free,   getArray,   getArray,   getArray,   getArray,   getBaseType,   getBaseTypeName,   getResultSet,   getResultSet,   getResultSet,   getResultSet
Method from java.sql.Array Detail:
 public  void free() throws SQLException
    This method frees the Array object and releases the resources that
it holds. The object is invalid once the free
method is called.

    
After free has been called, any attempt to invoke a
method other than free will result in a SQLException
being thrown. If free is called multiple times, the subsequent
calls to free are treated as a no-op.

 public Object getArray() throws SQLException
    Retrieves the contents of the SQL 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.

    
Note: When getArray is used to materialize
a base type that maps to a primitive data type, then it is
implementation-defined whether the array returned is an array of
that primitive data type or an array of Object.
 public Object getArray(Map map) throws SQLException
    Retrieves the contents of the SQL 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
getArray uses either the given type map or the standard mapping;
it never uses the type map associated with the connection.

    
Note: When getArray is used to materialize
a base type that maps to a primitive data type, then it is
implementation-defined whether the array returned is an array of
that primitive data type or an array of Object.
 public Object getArray(long index,
    int count) throws SQLException
    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. This method uses the type map
associated with the connection for customizations of the type mappings.

    
Note: When getArray is used to materialize
a base type that maps to a primitive data type, then it is
implementation-defined whether the array returned is an array of
that primitive data type or an array of Object.
 public Object getArray(long index,
    int count,
    Map map) throws SQLException
    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.

    
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.

    
Note: When getArray is used to materialize
a base type that maps to a primitive data type, then it is
implementation-defined whether the array returned is an array of
that primitive data type or an array of Object.
 public int getBaseType() throws SQLException
    Retrieves the JDBC type of the elements in the array designated
by this Array object.
 public String getBaseTypeName() throws SQLException
    Retrieves the SQL type name of the elements in
the array designated by this 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.
 public ResultSet getResultSet() throws SQLException
    Retrieves a result set that contains the elements of the SQL
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.
 public ResultSet getResultSet(Map map) throws SQLException
    Retrieves a result set that contains the elements of the SQL
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.
 public ResultSet getResultSet(long index,
    int count) throws SQLException
    Retrieves a result set holding the elements of the subarray that
starts at index 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.
 public ResultSet getResultSet(long index,
    int count,
    Map map) throws SQLException
    Retrieves a result set holding the elements of the subarray that
starts at index 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.