org.hsqldb.jdbc

Class jdbcParameterMetaData

public class jdbcParameterMetaData extends Object implements ParameterMetaData

An object that can be used to get information about the types and properties of the parameters in a PreparedStatement object.

Since: JDK 1.4, HSQLDB 1.7.2

Author: boucherb@users

Method Summary
StringgetParameterClassName(int param)
Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.
intgetParameterCount()
Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object provides information.
intgetParameterMode(int param)
Retrieves the designated parameter's mode.
intgetParameterType(int param)
Retrieves the designated parameter's SQL type.
StringgetParameterTypeName(int param)
Retrieves the designated parameter's database-specific type name.
intgetPrecision(int param)
Retrieves the designated parameter's number of decimal digits.
intgetScale(int param)
Retrieves the designated parameter's number of digits to right of the decimal point.
intisNullable(int param)
Retrieves whether null values are allowed in the designated parameter.
booleanisSigned(int param)
Retrieves whether values for the designated parameter can be signed numbers.
StringtoString()
Retrieves a String repsentation of this object.

Method Detail

getParameterClassName

public String getParameterClassName(int param)
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.

Throws: SQLException if a database access error occurs

Since: JDK 1.4, HSQLDB 1.7.2

getParameterCount

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

Returns: the number of parameters

Throws: SQLException if a database access error occurs

Since: JDK 1.4, HSQLDB 1.7.2

getParameterMode

public int getParameterMode(int param)
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

Throws: SQLException if a database access error occurs

Since: JDK 1.4, HSQLDB 1.7.2

getParameterType

public int getParameterType(int param)
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

Throws: SQLException if a database access error occurs

Since: JDK 1.4, HSQLDB 1.7.2

See Also: java.sql.Types

getParameterTypeName

public String getParameterTypeName(int param)
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.

Throws: SQLException if a database access error occurs

Since: JDK 1.4, HSQLDB 1.7.2

getPrecision

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

Parameters: param the first parameter is 1, the second is 2, ...

Returns: precision

Throws: SQLException if a database access error occurs

Since: JDK 1.4, HSQLDB 1.7.2

getScale

public int getScale(int param)
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

Throws: SQLException if a database access error occurs

Since: JDK 1.4, HSQLDB 1.7.2

isNullable

public int isNullable(int param)
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

Throws: SQLException if a database access error occurs

Since: JDK 1.4, HSQLDB 1.7.2

isSigned

public boolean isSigned(int param)
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

Throws: SQLException if a database access error occurs

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.