FileDocCategorySizeDatePackage
ParameterMetaData.javaAPI DocJava SE 5 API5409Fri Aug 26 14:57:18 BST 2005java.sql

ParameterMetaData

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

Fields Summary
int
parameterNoNulls
The constant indicating that a parameter will not allow NULL values.
int
parameterNullable
The constant indicating that a parameter will allow NULL values.
int
parameterNullableUnknown
The constant indicating that the nullability of a parameter is unknown.
int
parameterModeUnknown
The constant indicating that the mode of the parameter is unknown.
int
parameterModeIn
The constant indicating that the parameter's mode is IN.
int
parameterModeInOut
The constant indicating that the parameter's mode is INOUT.
int
parameterModeOut
The constant indicating that the parameter's mode is OUT.
Constructors Summary
Methods Summary
public java.lang.StringgetParameterClassName(int param)
Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.

param
param the first parameter is 1, the second is 2, ...
return
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.
exception
SQLException if a database access error occurs
since
1.4

public intgetParameterCount()
Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.

return
the number of parameters
exception
SQLException if a database access error occurs
since
1.4

public intgetParameterMode(int param)
Retrieves the designated parameter's mode.

param
param the first parameter is 1, the second is 2, ...
return
mode of the parameter; one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, or ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown.
exception
SQLException if a database access error occurs
since
1.4

public intgetParameterType(int param)
Retrieves the designated parameter's SQL type.

param
param the first parameter is 1, the second is 2, ...
return
SQL type from java.sql.Types
exception
SQLException if a database access error occurs
since
1.4
see
Types

public java.lang.StringgetParameterTypeName(int param)
Retrieves the designated parameter's database-specific type name.

param
param the first parameter is 1, the second is 2, ...
return
type the name used by the database. If the parameter type is a user-defined type, then a fully-qualified type name is returned.
exception
SQLException if a database access error occurs
since
1.4

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

param
param the first parameter is 1, the second is 2, ...
return
precision
exception
SQLException if a database access error occurs
since
1.4

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

param
param the first parameter is 1, the second is 2, ...
return
scale
exception
SQLException if a database access error occurs
since
1.4

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

param
param the first parameter is 1, the second is 2, ...
return
the nullability status of the given parameter; one of ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable, or ParameterMetaData.parameterNullableUnknown
exception
SQLException if a database access error occurs
since
1.4

public booleanisSigned(int param)
Retrieves whether values for the designated parameter can be signed numbers.

param
param the first parameter is 1, the second is 2, ...
return
true if so; false otherwise
exception
SQLException if a database access error occurs
since
1.4