class Array

Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages

acdk::sql::Array Class Reference

#include <Array.h>

Inheritance diagram for acdk::sql::Array:

List of all members.


Public Member Functions
virtual RString	getBaseTypeName ()=0 throw ( RSQLException )
	This method returns the name of the SQL type of the elements in this array.
virtual int	getBaseType ()=0 throw ( RSQLException )
	This method returns the JDBC type identifier of the elements in this array.
virtual acdk::lang::Object	getArray ()=0 throw ( RSQLException )
	This method returns the contents of this array.
virtual acdk::lang::Object	getArray (IN(acdk::util::RMap) map)=0 throw ( RSQLException )
	This method returns the contents of this array.
virtual acdk::lang::Object	getArray (int offset, int count)=0 throw ( RSQLException )
	This method returns a portion of this array starting at index `offset` into the array and continuing for `length` elements.
virtual acdk::lang::Object	getArray (int index, int count, IN(acdk::util::RMap) map)=0 throw ( RSQLException )
	This method returns a portion of this array starting at index `offset` into the array and continuing for `length` elements.
virtual RResultSet	getResultSet ()=0 throw ( RSQLException )
	This method returns the elements in the array as a `ResultSet`.
virtual RResultSet	getResultSet (IN(acdk::util::RMap) map)=0 throw ( RSQLException )
	This method returns the elements in the array as a `ResultSet`.
virtual RResultSet	getResultSet (int index, int count)=0 throw ( RSQLException )
	This method returns a portion of the array as a `ResultSet`.
virtual RResultSet	getResultSet (int index, int count, IN(acdk::util::RMap) map)=0 throw ( RSQLException )
	This method returns a portion of the array as a `ResultSet`.

Member Function Documentation

virtual acdk::lang::Object acdk::sql::Array::getArray ( int index,

int count,

IN(acdk::util::RMap) map

) throw ( RSQLException ) [pure virtual]

This method returns a portion of this array starting at index offset into the array and continuing for length 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:

offset 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.

Exceptions:

SQLException If an error occurs.

virtual acdk::lang::Object acdk::sql::Array::getArray ( int offset,

int count

) throw ( RSQLException ) [pure virtual]

This method returns a portion of this array starting at index offset into the array and continuing for length 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:

offset 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.

Exceptions:

SQLException If an error occurs.

virtual acdk::lang::Object acdk::sql::Array::getArray ( IN(acdk::util::RMap) map ) throw ( RSQLException ) [pure virtual]

This method 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.

Exceptions:

SQLException If an error occurs.

virtual acdk::lang::Object acdk::sql::Array::getArray ( ) throw ( RSQLException ) [pure virtual]

This method 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.

Exceptions:

SQLException If an error occurs.

Implemented in acdk::sql::odbc::ODBCArray.

virtual int acdk::sql::Array::getBaseType ( ) throw ( RSQLException ) [pure virtual]

This method 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.

Exceptions:

SQLException If an error occurs.

See also:
Types

Implemented in acdk::sql::odbc::ODBCArray.

virtual RString acdk::sql::Array::getBaseTypeName ( ) throw ( RSQLException ) [pure virtual]

This method returns the name of the SQL type of the elements in this array.
This name is database specific.

Parameters:

The name of the SQL type of the elements in this array.

Exceptions:

SQLException If an error occurs.

Implemented in acdk::sql::odbc::ODBCArray.

virtual RResultSet acdk::sql::Array::getResultSet ( int index,

int count,

IN(acdk::util::RMap) map

) throw ( RSQLException ) [pure virtual]

This method returns a portion of the array as a ResultSet.
The returned portion will start at index offset into the array and up to length 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:

offset The index into the array to start returning elements from.

length 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.

Exceptions:

SQLException If an error occurs.

See also:
ResultSet

virtual RResultSet acdk::sql::Array::getResultSet ( int index,

int count

) throw ( RSQLException ) [pure virtual]

This method returns a portion of the array as a ResultSet.
The returned portion will start at index offset into the array and up to length 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:

offset The index into the array to start returning elements from.

length The requested number of elements to return.

Returns:
The requested elements of this array as a ResultSet.

Exceptions:

SQLException If an error occurs.

See also:
ResultSet

virtual RResultSet acdk::sql::Array::getResultSet ( IN(acdk::util::RMap) map ) throw ( RSQLException ) [pure virtual]

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.

Exceptions:

SQLException If an error occurs.

See also:
ResultSet

virtual RResultSet acdk::sql::Array::getResultSet ( ) throw ( RSQLException ) [pure virtual]

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.

Returns:
The elements of this array as a ResultSet.

Exceptions:

SQLException If an error occurs.

See also:
ResultSet

Implemented in acdk::sql::odbc::ODBCArray.

class Array

acdk::sql::Array Class Reference

Public Member Functions

Member Function Documentation