org.apache.derby.iapi.jdbc
Interface EngineParameterMetaData

All Known Implementing Classes:
EmbedParameterMetaData30, EmbedParameterMetaData40, EmbedParameterSetMetaData

public interface EngineParameterMetaData

An internal api only, mainly for use in the network server. This interface imitates the ParameterMetaData interface from JDBC3.0 We want to provide the ParameterMetaData functionality to JDKs before JDBC3.0. org.apache.derby.iapi.jdbc.EnginePreparedStatement interface returns an object of this type on a getEmbedParameterSetMetaData Once,JDK1.3 stops being supported, this interface can be removed and instead the JDBC 3.0 Class ParameterMetaData can be used


Method Summary
 java.lang.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 contains information.
 int getParameterMode(int param)
          Retrieves the designated parameter's mode.
 int getParameterType(int param)
          Retrieves the designated parameter's SQL type.
 java.lang.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.
 

Method Detail

getParameterCount

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

Returns:
the number of parameters

isNullable

int isNullable(int param)
               throws java.sql.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
Throws:
java.sql.SQLException - if a database access error occurs

isSigned

boolean isSigned(int param)
                 throws java.sql.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 it can be signed numbers
Throws:
java.sql.SQLException - if a database access error occurs

getPrecision

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

Parameters:
param - - the first parameter is 1, the second is 2, ...
Returns:
precision
Throws:
java.sql.SQLException - if a database access error occurs

getScale

int getScale(int param)
             throws java.sql.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
Throws:
java.sql.SQLException - if a database access error occurs

getParameterType

int getParameterType(int param)
                     throws java.sql.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
Throws:
java.sql.SQLException - if a database access error occurs

getParameterTypeName

java.lang.String getParameterTypeName(int param)
                                      throws java.sql.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.
Throws:
java.sql.SQLException - if a database access error occurs

getParameterClassName

java.lang.String getParameterClassName(int param)
                                       throws java.sql.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.
Throws:
java.sql.SQLException - if a database access error occurs

getParameterMode

int getParameterMode(int param)
                     throws java.sql.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, or ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown.
Throws:
java.sql.SQLException - if a database access error occurs

Built on Thu 2011-03-10 11:54:14+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.