Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

java.sql
Interface 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

Field Summary
static int parameterModeIn sample code for java.sql.ParameterMetaData.parameterModeIn definition code for java.sql.ParameterMetaData.parameterModeIn
          The constant indicating that the parameter's mode is IN.
static int parameterModeInOut sample code for java.sql.ParameterMetaData.parameterModeInOut definition code for java.sql.ParameterMetaData.parameterModeInOut
          The constant indicating that the parameter's mode is INOUT.
static int parameterModeOut sample code for java.sql.ParameterMetaData.parameterModeOut definition code for java.sql.ParameterMetaData.parameterModeOut
          The constant indicating that the parameter's mode is OUT.
static int parameterModeUnknown sample code for java.sql.ParameterMetaData.parameterModeUnknown definition code for java.sql.ParameterMetaData.parameterModeUnknown
          The constant indicating that the mode of the parameter is unknown.
static int parameterNoNulls sample code for java.sql.ParameterMetaData.parameterNoNulls definition code for java.sql.ParameterMetaData.parameterNoNulls
          The constant indicating that a parameter will not allow NULL values.
static int parameterNullable sample code for java.sql.ParameterMetaData.parameterNullable definition code for java.sql.ParameterMetaData.parameterNullable
          The constant indicating that a parameter will allow NULL values.
static int parameterNullableUnknown sample code for java.sql.ParameterMetaData.parameterNullableUnknown definition code for java.sql.ParameterMetaData.parameterNullableUnknown
          The constant indicating that the nullability of a parameter is unknown.
 
Method Summary
 String sample code for java.lang.String definition code for java.lang.String getParameterClassName sample code for java.sql.ParameterMetaData.getParameterClassName(int) definition code for java.sql.ParameterMetaData.getParameterClassName(int) (int param)
          Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.
 int getParameterCount sample code for java.sql.ParameterMetaData.getParameterCount() definition code for java.sql.ParameterMetaData.getParameterCount() ()
          Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.
 int getParameterMode sample code for java.sql.ParameterMetaData.getParameterMode(int) definition code for java.sql.ParameterMetaData.getParameterMode(int) (int param)
          Retrieves the designated parameter's mode.
 int getParameterType sample code for java.sql.ParameterMetaData.getParameterType(int) definition code for java.sql.ParameterMetaData.getParameterType(int) (int param)
          Retrieves the designated parameter's SQL type.
 String sample code for java.lang.String definition code for java.lang.String getParameterTypeName sample code for java.sql.ParameterMetaData.getParameterTypeName(int) definition code for java.sql.ParameterMetaData.getParameterTypeName(int) (int param)
          Retrieves the designated parameter's database-specific type name.
 int getPrecision sample code for java.sql.ParameterMetaData.getPrecision(int) definition code for java.sql.ParameterMetaData.getPrecision(int) (int param)
          Retrieves the designated parameter's number of decimal digits.
 int getScale sample code for java.sql.ParameterMetaData.getScale(int) definition code for java.sql.ParameterMetaData.getScale(int) (int param)
          Retrieves the designated parameter's number of digits to right of the decimal point.
 int isNullable sample code for java.sql.ParameterMetaData.isNullable(int) definition code for java.sql.ParameterMetaData.isNullable(int) (int param)
          Retrieves whether null values are allowed in the designated parameter.
 boolean isSigned sample code for java.sql.ParameterMetaData.isSigned(int) definition code for java.sql.ParameterMetaData.isSigned(int) (int param)
          Retrieves whether values for the designated parameter can be signed numbers.
 

Field Detail

parameterNoNulls sample code for java.sql.ParameterMetaData.parameterNoNulls 

static final int parameterNoNulls
The constant indicating that a parameter will not allow NULL values.

See Also:
Constant Field Values

parameterNullable sample code for java.sql.ParameterMetaData.parameterNullable 

static final int parameterNullable
The constant indicating that a parameter will allow NULL values.

See Also:
Constant Field Values

parameterNullableUnknown sample code for java.sql.ParameterMetaData.parameterNullableUnknown 

static final int parameterNullableUnknown
The constant indicating that the nullability of a parameter is unknown.

See Also:
Constant Field Values

parameterModeUnknown sample code for java.sql.ParameterMetaData.parameterModeUnknown 

static final int parameterModeUnknown
The constant indicating that the mode of the parameter is unknown.

See Also:
Constant Field Values

parameterModeIn sample code for java.sql.ParameterMetaData.parameterModeIn 

static final int parameterModeIn
The constant indicating that the parameter's mode is IN.

See Also:
Constant Field Values

parameterModeInOut sample code for java.sql.ParameterMetaData.parameterModeInOut 

static final int parameterModeInOut
The constant indicating that the parameter's mode is INOUT.

See Also:
Constant Field Values

parameterModeOut sample code for java.sql.ParameterMetaData.parameterModeOut 

static final int parameterModeOut
The constant indicating that the parameter's mode is OUT.

See Also:
Constant Field Values
Method Detail

getParameterCount sample code for java.sql.ParameterMetaData.getParameterCount() definition code for java.sql.ParameterMetaData.getParameterCount() 

int getParameterCount()
                      throws SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException
Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.

Returns:
the number of parameters
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4

isNullable sample code for java.sql.ParameterMetaData.isNullable(int) definition code for java.sql.ParameterMetaData.isNullable(int) 

int isNullable(int param)
               throws SQLException sample code for java.sql.SQLException definition code for 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:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4

isSigned sample code for java.sql.ParameterMetaData.isSigned(int) definition code for java.sql.ParameterMetaData.isSigned(int) 

boolean isSigned(int param)
                 throws SQLException sample code for java.sql.SQLException definition code for 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 so; false otherwise
Throws:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4

getPrecision sample code for java.sql.ParameterMetaData.getPrecision(int) definition code for java.sql.ParameterMetaData.getPrecision(int) 

int getPrecision(int param)
                 throws SQLException sample code for java.sql.SQLException definition code for 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:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4

getScale sample code for java.sql.ParameterMetaData.getScale(int) definition code for java.sql.ParameterMetaData.getScale(int) 

int getScale(int param)
             throws SQLException sample code for java.sql.SQLException definition code for 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:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4

getParameterType sample code for java.sql.ParameterMetaData.getParameterType(int) definition code for java.sql.ParameterMetaData.getParameterType(int) 

int getParameterType(int param)
                     throws SQLException sample code for java.sql.SQLException definition code for 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:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4
See Also:
Types sample code for java.sql.Types definition code for java.sql.Types

getParameterTypeName sample code for java.sql.ParameterMetaData.getParameterTypeName(int) definition code for java.sql.ParameterMetaData.getParameterTypeName(int) 

String sample code for java.lang.String definition code for java.lang.String  getParameterTypeName(int param)
                            throws SQLException sample code for java.sql.SQLException definition code for 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:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4

getParameterClassName sample code for java.sql.ParameterMetaData.getParameterClassName(int) definition code for java.sql.ParameterMetaData.getParameterClassName(int) 

String sample code for java.lang.String definition code for java.lang.String  getParameterClassName(int param)
                             throws SQLException sample code for java.sql.SQLException definition code for 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:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4

getParameterMode sample code for java.sql.ParameterMetaData.getParameterMode(int) definition code for java.sql.ParameterMetaData.getParameterMode(int) 

int getParameterMode(int param)
                     throws SQLException sample code for java.sql.SQLException definition code for 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:
SQLException sample code for java.sql.SQLException definition code for java.sql.SQLException - if a database access error occurs
Since:
1.4
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD