interbase.interclient
Class ParameterMetaData

java.lang.Object
  |
  +--interbase.interclient.ParameterMetaData

public final class ParameterMetaData

extends Object

Describes input column information for the parameters of a prepared statement.

ParameterMetaData is an InterClient extension to JDBC for describing the parameters to a prepared statement dynamically.

ParameterMetaData is extracted from a PreparedStatement using PreparedStatement.getParameterMetaData(). This provides a means to get metadata describing the input parameters to a dynamically prepared statement (SQL DESCRIBE INPUT functionality).

This class was proposed for inclusion in JDBC 2.0, but was rejected due to lack of underlying support of some RDBMS vendors.

Since:

Extension, since InterClient 1.0

Method Summary

int	getArrayBaseType(int parameterIndex) Gets an array parameter's base SQL type.
int[][]	getArrayDimensions(int parameterIndex) Gets an array parameters dimension and bounds.
int	getParameterCount() Gets the number of input parameters of a dynamically prepared statement.
int	getParameterType(int parameterIndex) Gets the parameter SQL type for an input column of a prepared statement.
String	getParameterTypeName(int parameterIndex) Gets the InterBase type name for an input column.
int	getPrecision(int parameterIndex) Gets the number of decimal digits for an input column.
int	getScale(int parameterIndex) Gets the number of digits to the right of the decimal for an input column.
boolean	isNullable(int parameterIndex) Can you put a null for this input column.

Methods inherited from class java.lang.Object

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

Method Detail

getParameterCount

public int getParameterCount()
                      throws SQLException

Gets the number of input parameters of a dynamically prepared statement.

Throws:

SQLException - if a database access error occurs

Since:

Extension, since InterClient 1.0

getParameterType

public int getParameterType(int parameterIndex)
                     throws SQLException

Gets the parameter SQL type for an input column of a prepared statement.

Returns:

a sql type from java.sql.Types

Throws:

SQLException - if a database access error occurs

Since:

Extension, since InterClient 1.0

getParameterTypeName

public String getParameterTypeName(int parameterIndex)
                            throws SQLException

Gets the InterBase type name for an input column.

Throws:

SQLException - if a database access error occurs

Since:

Extension, since InterClient 1.0

getPrecision

public int getPrecision(int parameterIndex)
                 throws SQLException

Gets the number of decimal digits for an input column.

Throws:

SQLException - if a database access error occurs

Since:

Extension, since InterClient 1.0, behavior subject to further functional refinement

getScale

public int getScale(int parameterIndex)
             throws SQLException

Gets the number of digits to the right of the decimal for an input column.

Throws:

SQLException - if a database access error occurs

Since:

Extension, since InterClient 1.0

isNullable

public boolean isNullable(int parameterIndex)
                   throws SQLException

Can you put a null for this input column.

Throws:

SQLException - if a database access error occurs

Since:

Extension, since InterClient 1.0

getArrayBaseType

public int getArrayBaseType(int parameterIndex)
                     throws SQLException

Gets an array parameter's base SQL type. The input column must be of sql type java.sql.Types.ARRAY.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

Throws:

SQLException - if a database access error occurs

Since:

Extension, proposed for InterClient 3.0

See Also:

java.sql.Types

getArrayDimensions

public int[][] getArrayDimensions(int parameterIndex)
                           throws SQLException

Gets an array parameters dimension and bounds. The input column must be of sql type java.sql.Types.ARRAY.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

Returns:

array of arrays of int describing array's dimensions and bounds for each dimensions.

Throws:

SQLException - if a database access error occurs

Since:

Extension, proposed for InterClient 3.0