Package org.hsqldb.jdbc
Class jdbcParameterMetaData
java.lang.Object
org.hsqldb.jdbc.jdbcParameterMetaData
- All Implemented Interfaces:
ParameterMetaData
,Wrapper
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
-
Field Summary
Fields inherited from interface java.sql.ParameterMetaData
parameterModeIn, parameterModeInOut, parameterModeOut, parameterModeUnknown, parameterNoNulls, parameterNullable, parameterNullableUnknown
-
Method Summary
Modifier and TypeMethodDescriptiongetParameterClassName
(int param) Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.int
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.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.boolean
isWrapperFor
(Class<?> iface) toString()
Retrieves a String repsentation of this object.<T> T
-
Method Details
-
getParameterClassName
Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.- Specified by:
getParameterClassName
in interfaceParameterMetaData
- 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
Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object provides information.- Specified by:
getParameterCount
in interfaceParameterMetaData
- Returns:
- the number of parameters
- Throws:
SQLException
- if a database access error occurs- Since:
- JDK 1.4, HSQLDB 1.7.2
-
getParameterMode
Retrieves the designated parameter's mode.- Specified by:
getParameterMode
in interfaceParameterMetaData
- 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
Retrieves the designated parameter's SQL type.- Specified by:
getParameterType
in interfaceParameterMetaData
- 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:
-
getParameterTypeName
Retrieves the designated parameter's database-specific type name.- Specified by:
getParameterTypeName
in interfaceParameterMetaData
- 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
Retrieves the designated parameter's number of decimal digits.- Specified by:
getPrecision
in interfaceParameterMetaData
- 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
Retrieves the designated parameter's number of digits to right of the decimal point.- Specified by:
getScale
in interfaceParameterMetaData
- 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
Retrieves whether null values are allowed in the designated parameter.- Specified by:
isNullable
in interfaceParameterMetaData
- 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
Retrieves whether values for the designated parameter can be signed numbers.- Specified by:
isSigned
in interfaceParameterMetaData
- 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
Retrieves a String repsentation of this object. -
unwrap
- Specified by:
unwrap
in interfaceWrapper
- Throws:
SQLException
-
isWrapperFor
- Specified by:
isWrapperFor
in interfaceWrapper
- Throws:
SQLException
-