org.hsqldb.jdbc

Class jdbcParameterMetaData

Implemented Interfaces:
ParameterMetaData

public class jdbcParameterMetaData
extends java.lang.Object
implements ParameterMetaData

An object that can be used to get information about the types and properties of the parameters in a PreparedStatement object.
Author:
boucherb@users
Since:
JDK 1.4, HSQLDB 1.7.2

Method Summary

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 ParameterMetaData object provides information.
int
getParameterMode(int param)
Retrieves the designated parameter's mode.
int
getParameterType(int param)
Retrieves the designated parameter's SQL type.
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.
String
toString()
Retrieves a String repsentation of this object.

Method Details

getParameterClassName

public String getParameterClassName(int param)
            throws SQLException
Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.

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.
Since:
JDK 1.4, HSQLDB 1.7.2

getParameterCount

public int getParameterCount()
            throws SQLException
Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object provides information.

Returns:
the number of parameters
Since:
JDK 1.4, HSQLDB 1.7.2

getParameterMode

public int getParameterMode(int param)
            throws SQLException
Retrieves the designated parameter's mode.

Parameters:
param - the first parameter is 1, the second is 2, ...
Returns:
mode of the parameter; one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, ParameterMetaData.parameterModeInOut, ParameterMetaData.parameterModeUnknown
Since:
JDK 1.4, HSQLDB 1.7.2

getParameterType

public int getParameterType(int param)
            throws SQLException
Retrieves the designated parameter's SQL type.

Parameters:
param - the first parameter is 1, the second is 2, ...
Returns:
SQL type from java.sql.Types
Since:
JDK 1.4, HSQLDB 1.7.2
See Also:
java.sql.Types

getParameterTypeName

public String getParameterTypeName(int param)
            throws SQLException
Retrieves the designated parameter's database-specific type name.

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.
Since:
JDK 1.4, HSQLDB 1.7.2

getPrecision

public int getPrecision(int param)
            throws SQLException
Retrieves the designated parameter's number of decimal digits.

Parameters:
param - the first parameter is 1, the second is 2, ...
Returns:
precision
Since:
JDK 1.4, HSQLDB 1.7.2

getScale

public int getScale(int param)
            throws SQLException
Retrieves the designated parameter's number of digits to right of the decimal point.

Parameters:
param - the first parameter is 1, the second is 2, ...
Returns:
scale
Since:
JDK 1.4, HSQLDB 1.7.2

isNullable

public int isNullable(int param)
            throws SQLException
Retrieves whether null values are allowed in the designated parameter.

Parameters:
param - the first parameter is 1, the second is 2, ...
Returns:
the nullability status of the given parameter; one of ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable or ParameterMetaData.parameterNullableUnknown
Since:
JDK 1.4, HSQLDB 1.7.2

isSigned

public boolean isSigned(int param)
            throws SQLException
Retrieves whether values for the designated parameter can be signed numbers.

Parameters:
param - the first parameter is 1, the second is 2, ...
Returns:
true if so; false otherwise
Since:
JDK 1.4, HSQLDB 1.7.2

toString

public String toString()
Retrieves a String repsentation of this object.

Returns:
a String repsentation of this object

Copyright B) 2001 - 2005 HSQL Development Group. All Rights Reserved.