oracle.jdbc
Interface OracleParameterMetaData

All Superinterfaces:

java.sql.ParameterMetaData

All Known Implementing Classes:

OracleParameterMetaData

public interface OracleParameterMetaData

extends java.sql.ParameterMetaData

This interface defines the Oracle extensions to the standard JDBC interface java.sql.ParameterMetaData. For pre-JDK 1.4 applications, this interface provides the equivalent functions in java.sql.ParameterMetaData. Applications can use java.sql.ParameterMetaData where they do not make use of Oracle extensions. However, when an application uses the Oracle extensions to java.sql.ParameterMetaData, it must use oracle.jdbc.OracleParameterMetaData.

This is an interface that can be used to get information about the types and properties of the parameters in a PreparedStatement object.

Field Summary

static int	parameterModeIn The constant indicating that the parameter's mode is IN.
static int	parameterModeInOut The constant indicating that the parameter's mode is INOUT.
static int	parameterModeOut The constant indicating that the parameter's mode is OUT.
static int	parameterModeUnknown The constant indicating that the mode of the parameter is unknown.
static int	parameterNoNulls The constant indicating that a parameter will not allow NULL values.
static int	parameterNullable The constant indicating that a parameter will allow NULL values.
static int	parameterNullableUnknown The constant indicating that the nullability of a parameter is unknown.

Method Summary

java.lang.String	getParameterClassName(int param) Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.
int	getParameterCount() Retrieves the number of parameters in the PreparedStatement object for which this OracleParameterMetaData object contains information.
int	getParameterMode(int param) Retrieves the designated parameter's mode.
int	getParameterType(int param) Retrieves the designated parameter's SQL type.
java.lang.String	getParameterTypeName(int param) Retrieves the designated parameter's database-specific type name.
int	getPrecision(int param) Retrieves the designated parameter's number of decimal digits.
int	getScale(int param) Retrieves the designated parameter's number of digits to right of the decimal point.
int	isNullable(int param) Retrieves whether null values are allowed in the designated parameter.
boolean	isSigned(int param) Retrieves whether values for the designated parameter can be signed numbers.

Field Detail

parameterNoNulls

public static final int parameterNoNulls

The constant indicating that a parameter will not allow NULL values.

See Also:

Constant Field Values

parameterNullable

public static final int parameterNullable

The constant indicating that a parameter will allow NULL values.

See Also:

Constant Field Values

parameterNullableUnknown

public static final int parameterNullableUnknown

The constant indicating that the nullability of a parameter is unknown.

See Also:

Constant Field Values

parameterModeUnknown

public static final int parameterModeUnknown

The constant indicating that the mode of the parameter is unknown.

See Also:

Constant Field Values

parameterModeIn

public static final int parameterModeIn

The constant indicating that the parameter's mode is IN.

See Also:

Constant Field Values

parameterModeInOut

public static final int parameterModeInOut

The constant indicating that the parameter's mode is INOUT.

See Also:

Constant Field Values

parameterModeOut

public static final int parameterModeOut

The constant indicating that the parameter's mode is OUT.

See Also:

Constant Field Values

Method Detail

getParameterCount

public int getParameterCount()
                      throws java.sql.SQLException

Retrieves the number of parameters in the PreparedStatement object for which this OracleParameterMetaData object contains information.

Specified by:

getParameterCount in interface java.sql.ParameterMetaData

Returns:

the number of parameters

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

isNullable

public int isNullable(int param)
               throws java.sql.SQLException

Retrieves whether null values are allowed in the designated parameter.

Specified by:

isNullable in interface java.sql.ParameterMetaData

Parameters:

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

Returns:

the nullability status of the given parameter; one of OracleParameterMetaData.parameterNoNulls, OracleParameterMetaData.parameterNullable, or OracleParameterMetaData.parameterNullableUnknown

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

isSigned

public boolean isSigned(int param)
                 throws java.sql.SQLException

Retrieves whether values for the designated parameter can be signed numbers.

Specified by:

isSigned in interface java.sql.ParameterMetaData

Parameters:

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

Returns:

true if so; false otherwise

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getPrecision

public int getPrecision(int param)
                 throws java.sql.SQLException

Retrieves the designated parameter's number of decimal digits.

Specified by:

getPrecision in interface java.sql.ParameterMetaData

Parameters:

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

Returns:

precision

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getScale

public int getScale(int param)
             throws java.sql.SQLException

Retrieves the designated parameter's number of digits to right of the decimal point.

Specified by:

getScale in interface java.sql.ParameterMetaData

Parameters:

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

Returns:

scale

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getParameterType

public int getParameterType(int param)
                     throws java.sql.SQLException

Retrieves the designated parameter's SQL type.

Specified by:

getParameterType in interface java.sql.ParameterMetaData

Parameters:

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

Returns:

SQL type from java.sql.Types

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

Types

getParameterTypeName

public java.lang.String getParameterTypeName(int param)
                                      throws java.sql.SQLException

Retrieves the designated parameter's database-specific type name.

Specified by:

getParameterTypeName in interface java.sql.ParameterMetaData

Parameters:

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

Returns:

type the name used by the database. If the parameter type is a user-defined type, then a fully-qualified type name is returned.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getParameterClassName

public java.lang.String getParameterClassName(int param)
                                       throws java.sql.SQLException

Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.

Specified by:

getParameterClassName in interface java.sql.ParameterMetaData

Parameters:

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

Returns:

the fully-qualified name of the class in the Java programming language that would be used by the method PreparedStatement.setObject to set the value in the specified parameter. This is the class name used for custom mapping.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getParameterMode

public int getParameterMode(int param)
                     throws java.sql.SQLException

Retrieves the designated parameter's mode.

Specified by:

getParameterMode in interface java.sql.ParameterMetaData

Parameters:

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

Returns:

mode of the parameter; one of OracleParameterMetaData.parameterModeIn, OracleParameterMetaData.parameterModeOut, or OracleParameterMetaData.parameterModeInOut OracleParameterMetaData.parameterModeUnknown.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2