oracle.sql
Class ArrayDescriptor

java.lang.Object
  |
  +--oracle.sql.TypeDescriptor
        |
        +--oracle.sql.ArrayDescriptor

public class ArrayDescriptor

extends TypeDescriptor

implements java.io.Serializable

See Also:

Serialized Form

Field Summary

static int	CACHE_ALL
static int	CACHE_LAST
static int	CACHE_NONE
static int	TYPE_NESTED_TABLE
static int	TYPE_VARRAY

Fields inherited from class oracle.sql.TypeDescriptor

DEBUG_SERIALIZATION

Method Summary

static ArrayDescriptor	createDescriptor(java.lang.String name, java.sql.Connection conn) Descriptor factory.
java.lang.String	descType() Describe the collection type.
int	getArrayType() Return the database type of the array.
java.lang.String	getBaseName() In case the elements are named types the fully qualified name of their type.Otherwise, return type name used by the database
int	getBaseType() Return element's type code.
long	getMaxLength() Return the maximun number of elements this array object can hold.
int	getTypeCode()
java.sql.ResultSet	toResultSet(ARRAY array, long index, int count, java.util.Map map, boolean saveLocalCopy)
java.sql.ResultSet	toResultSetFromImage(ARRAY array, long index, int count, java.util.Map map)

Methods inherited from class oracle.sql.TypeDescriptor

getName, getSubtypeName, setConnection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_VARRAY

public static final int TYPE_VARRAY

TYPE_NESTED_TABLE

public static final int TYPE_NESTED_TABLE

CACHE_NONE

public static final int CACHE_NONE

CACHE_ALL

public static final int CACHE_ALL

CACHE_LAST

public static final int CACHE_LAST

Method Detail

createDescriptor

public static ArrayDescriptor createDescriptor(java.lang.String name,
                                               java.sql.Connection conn)
                                        throws java.sql.SQLException

Descriptor factory. Lookup the name in the database, and determine the characteristics of this array.

Parameters:

name - a String naming the type. (Not necessarily fully qualified)

connection - a Connection to a database

Throws:

java.sql.SQLException - if the name does not name an array type.

getBaseType

public int getBaseType()
                throws java.sql.SQLException

Return element's type code.

Returns:

the type code of elements of the array

getBaseName

public java.lang.String getBaseName()
                             throws java.sql.SQLException

In case the elements are named types the fully qualified name of their type.Otherwise, return type name used by the database

Returns:

the name of the base type.

Throws:

java.sql.SQLException - if the element's type is not named.

getArrayType

public int getArrayType()
                 throws java.sql.SQLException

Return the database type of the array. The possible return values are ArrayDescriptor.TYPE_VARRAY and ArrayDescriptor.TYPE_NESTED_TABLE.

Returns:

database array type.

getMaxLength

public long getMaxLength()
                  throws java.sql.SQLException

Return the maximun number of elements this array object can hold.

Returns:

the maximum array size; return 0 if no limit.

descType

public java.lang.String descType()
                          throws java.sql.SQLException

Describe the collection type.

Returns:

the type information

Since:

8.1.7

toResultSet

public java.sql.ResultSet toResultSet(ARRAY array,
                                      long index,
                                      int count,
                                      java.util.Map map,
                                      boolean saveLocalCopy)
                               throws java.sql.SQLException

toResultSetFromImage

public java.sql.ResultSet toResultSetFromImage(ARRAY array,
                                               long index,
                                               int count,
                                               java.util.Map map)
                                        throws java.sql.SQLException

getTypeCode

public int getTypeCode()
                throws java.sql.SQLException