org.firebirdsql.jdbc

Class FBParameterMetaData

java.lang.Object

org.firebirdsql.jdbc.FBParameterMetaData

All Implemented Interfaces:

java.sql.ParameterMetaData, java.sql.Wrapper, FirebirdParameterMetaData

public class FBParameterMetaData
extends java.lang.Object
implements FirebirdParameterMetaData

Describe class FBParameterMetaData here.

Version:

1.0

Author:

Nickolay Samofatov

Field Summary

Fields inherited from interface org.firebirdsql.jdbc.FirebirdParameterMetaData

parameterModeIn, parameterModeInOut, parameterModeOut, parameterModeUnknown, parameterNoNulls, parameterNullable, parameterNullableUnknown

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FBParameterMetaData(XSQLVAR[] xsqlvars, org.firebirdsql.gds.impl.GDSHelper connection) Creates a new FBParameterMetaData instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getParameterClassName(int parameter) 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 contains information.
int	getParameterMode(int param) Retrieves the designated parameter's mode.
int	getParameterType(int parameter) Retrieves the designated parameter's SQL type.
java.lang.String	getParameterTypeName(int parameter) Retrieves the designated parameter's database-specific type name.
int	getPrecision(int parameter) Retrieves the designated parameter's number of decimal digits.
int	getScale(int parameter) Retrieves the designated parameter's number of digits to right of the decimal point.
int	isNullable(int parameter) Retrieves whether null values are allowed in the designated parameter.
boolean	isSigned(int parameter) Retrieves whether values for the designated parameter can be signed numbers.
boolean	isWrapperFor(java.lang.Class<?> iface)
<T> T	unwrap(java.lang.Class<T> iface)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FBParameterMetaData

protected FBParameterMetaData(XSQLVAR[] xsqlvars,
                              org.firebirdsql.gds.impl.GDSHelper connection)
                       throws java.sql.SQLException

Creates a new FBParameterMetaData instance.

Parameters:

xsqlvars - a XSQLVAR[] value

connection - a AbstractConnection value

Throws:

java.sql.SQLException - if an error occurs

Method Detail

getParameterCount

public int getParameterCount()

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

Specified by:

getParameterCount in interface java.sql.ParameterMetaData

Specified by:

getParameterCount in interface FirebirdParameterMetaData

Returns:

the number of parameters

Throws:

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

Since:

1.4

isNullable

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

Retrieves whether null values are allowed in the designated parameter.

Specified by:

isNullable in interface java.sql.ParameterMetaData

Specified by:

isNullable in interface FirebirdParameterMetaData

Parameters:

parameter - 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:

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

Since:

1.4

isSigned

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

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

Specified by:

isSigned in interface java.sql.ParameterMetaData

Specified by:

isSigned in interface FirebirdParameterMetaData

Parameters:

parameter - 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:

1.4

getPrecision

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

Retrieves the designated parameter's number of decimal digits.

Specified by:

getPrecision in interface java.sql.ParameterMetaData

Specified by:

getPrecision in interface FirebirdParameterMetaData

Parameters:

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

Returns:

precision

Throws:

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

Since:

1.4

getScale

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

Specified by:

getScale in interface FirebirdParameterMetaData

Parameters:

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

Returns:

scale

Throws:

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

Since:

1.4

getParameterType

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

Retrieves the designated parameter's SQL type.

Specified by:

getParameterType in interface java.sql.ParameterMetaData

Specified by:

getParameterType in interface FirebirdParameterMetaData

Parameters:

parameter - 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:

1.4

See Also:

Types

getParameterTypeName

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

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

Specified by:

getParameterTypeName in interface java.sql.ParameterMetaData

Specified by:

getParameterTypeName in interface FirebirdParameterMetaData

Parameters:

parameter - 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:

1.4

getParameterClassName

public java.lang.String getParameterClassName(int parameter)
                                       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

Specified by:

getParameterClassName in interface FirebirdParameterMetaData

Parameters:

parameter - 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:

1.4

getParameterMode

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

Retrieves the designated parameter's mode.

Specified by:

getParameterMode in interface java.sql.ParameterMetaData

Specified by:

getParameterMode in interface FirebirdParameterMetaData

Parameters:

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

Returns:

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

Throws:

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

Since:

1.4

isWrapperFor

public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException

Specified by:

isWrapperFor in interface java.sql.Wrapper

Throws:

java.sql.SQLException

unwrap

public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException

Specified by:

unwrap in interface java.sql.Wrapper

Throws:

java.sql.SQLException