Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

java.sql
Interface Array  view Array download Array.java


public interface Array

This interface provides methods for accessing SQL array types.


Method Summary
 java.lang.Object getArray()
          Returns the contents of this array.
 java.lang.Object getArray(long start, int count)
          Returns a portion of this array starting at start into the array and continuing for count elements.
 java.lang.Object getArray(long start, int count, java.util.Map map)
          This method returns a portion of this array starting at start into the array and continuing for count elements.
 java.lang.Object getArray(java.util.Map map)
          Returns the contents of this array.
 int getBaseType()
          Returns the JDBC type identifier of the elements in this array.
 java.lang.String getBaseTypeName()
          Returns the name of the SQL type of the elements in this array.
 ResultSet getResultSet()
          Returns the elements in the array as a ResultSet.
 ResultSet getResultSet(long start, int count)
          This method returns a portion of the array as a ResultSet.
 ResultSet getResultSet(long start, int count, java.util.Map map)
          This method returns a portion of the array as a ResultSet.
 ResultSet getResultSet(java.util.Map map)
          This method returns the elements in the array as a ResultSet.
 

Method Detail

getBaseTypeName

public java.lang.String getBaseTypeName()
                                 throws SQLException
Returns the name of the SQL type of the elements in this array. This name is database specific.


getBaseType

public int getBaseType()
                throws SQLException
Returns the JDBC type identifier of the elements in this array. This will be one of the values defined in the Types class.


getArray

public java.lang.Object getArray()
                          throws SQLException
Returns the contents of this array. This object returned will be an array of Java objects of the appropriate types.


getArray

public java.lang.Object getArray(java.util.Map map)
                          throws SQLException
Returns the contents of this array. The specified Map will be used to override selected mappings between SQL types and Java classes.


getArray

public java.lang.Object getArray(long start,
                                 int count)
                          throws SQLException
Returns a portion of this array starting at start 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.


getArray

public java.lang.Object getArray(long start,
                                 int count,
                                 java.util.Map map)
                          throws SQLException
This method returns a portion of this array starting at start 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.


getResultSet

public ResultSet getResultSet()
                       throws SQLException
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.


getResultSet

public ResultSet getResultSet(java.util.Map map)
                       throws SQLException
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.


getResultSet

public ResultSet getResultSet(long start,
                              int count)
                       throws SQLException
This method returns a portion of the array as a ResultSet. The returned portion will start at start 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.


getResultSet

public ResultSet getResultSet(long start,
                              int count,
                              java.util.Map map)
                       throws SQLException
This method returns a portion of the array as a ResultSet. The returned portion will start at start 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.