Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

java.sql

Interface Array

public interface Array
This interface provides methods for accessing SQL array types.

Method Summary

Object
getArray()
Returns the contents of this array.
Object
getArray(Map> map)
Returns the contents of this array.
Object
getArray(long start, int count)
Returns a portion of this array starting at start into the array and continuing for count elements.
Object
getArray(long start, int count, Map> map)
This method returns a portion of this array starting at start into the array and continuing for count elements.
int
getBaseType()
Returns the JDBC type identifier of the elements in this array.
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(Map> map)
This method 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, Map> map)
This method returns a portion of the array as a ResultSet.

Method Details

getArray

public Object getArray()
            throws SQLException
Returns the contents of this array. This object returned will be an array of Java objects of the appropriate types.
Returns:
The contents of the array as an array of Java objects.
Throws:
SQLException - If an error occurs.

getArray

public Object getArray(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.
Parameters:
map - A mapping of SQL types to Java classes.
Returns:
The contents of the array as an array of Java objects.
Throws:
SQLException - If an error occurs.

getArray

public 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.
Parameters:
start - The offset into this array to start returning elements from.
count - The requested number of elements to return.
Returns:
The requested portion of the array.
Throws:
SQLException - If an error occurs.

getArray

public Object getArray(long start,
                       int count,
                       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.
Parameters:
start - The offset into this array to start returning elements from.
count - The requested number of elements to return.
map - A mapping of SQL types to Java classes.
Returns:
The requested portion of the array.
Throws:
SQLException - If an error occurs.

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.
Returns:
The JDBC type of the elements in this array.
Throws:
SQLException - If an error occurs.
See Also:
Types

getBaseTypeName

public String getBaseTypeName()
            throws SQLException
Returns the name of the SQL type of the elements in this array. This name is database specific.
Returns:
The name of the SQL type of the elements in this array.
Throws:
SQLException - If an error occurs.

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.
Returns:
The elements of this array as a ResultSet.
Throws:
SQLException - If an error occurs.
See Also:
ResultSet

getResultSet

public ResultSet getResultSet(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.
Parameters:
map - A mapping of SQL types to Java classes.
Returns:
The elements of this array as a ResultSet.
Throws:
SQLException - If an error occurs.
See Also:
ResultSet

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.

Parameters:
start - The index into the array to start returning elements from.
count - The requested number of elements to return.
Returns:
The requested elements of this array as a ResultSet.
Throws:
SQLException - If an error occurs.
See Also:
ResultSet

getResultSet

public ResultSet getResultSet(long start,
                              int count,
                              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.

Parameters:
start - The index into the array to start returning elements from.
count - The requested number of elements to return.
map - A mapping of SQL types to Java classes.
Returns:
The requested elements of this array as a ResultSet.
Throws:
SQLException - If an error occurs.
See Also:
ResultSet
Array.java -- Interface for accessing SQL array object Copyright (C) 1999, 2000, 2002, 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.

Overview Package Class Use Source Tree Index Deprecated About