Home » openjdk-7 » java » sql » [javadoc | source]
java.sql
public interface: ParameterMetaData [javadoc | source]

All Implemented Interfaces:
    Wrapper

An object that can be used to get information about the types and properties for each parameter marker in a PreparedStatement object. For some queries and driver implementations, the data that would be returned by a ParameterMetaData object may not be available until the PreparedStatement has been executed.

Some driver implementations may not be able to provide information about the types and properties for each parameter marker in a CallableStatement object.

Field 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. 
Method from java.sql.ParameterMetaData Summary:
getParameterClassName,   getParameterCount,   getParameterMode,   getParameterType,   getParameterTypeName,   getPrecision,   getScale,   isNullable,   isSigned
Method from java.sql.ParameterMetaData Detail:
 public String getParameterClassName(int param) throws SQLException
    Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.
 public int getParameterCount() throws SQLException
    Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.
 public int getParameterMode(int param) throws SQLException
    Retrieves the designated parameter's mode.
 public int getParameterType(int param) throws SQLException
    Retrieves the designated parameter's SQL type.
 public String getParameterTypeName(int param) throws SQLException
    Retrieves the designated parameter's database-specific type name.
 public int getPrecision(int param) throws SQLException
    Retrieves the designated parameter's specified column size.

    The returned value represents the maximum column size for the given parameter. For numeric data, this is the maximum precision. For character data, this is the length in characters. For datetime datatypes, this is the length in characters of the String representation (assuming the maximum allowed precision of the fractional seconds component). For binary data, this is the length in bytes. For the ROWID datatype, this is the length in bytes. 0 is returned for data types where the column size is not applicable.

 public int getScale(int param) throws SQLException
    Retrieves the designated parameter's number of digits to right of the decimal point. 0 is returned for data types where the scale is not applicable.
 public int isNullable(int param) throws SQLException
    Retrieves whether null values are allowed in the designated parameter.
 public boolean isSigned(int param) throws SQLException
    Retrieves whether values for the designated parameter can be signed numbers.