Class jdbcParameterMetaData

java.lang.Object
org.hsqldb.jdbc.jdbcParameterMetaData
All Implemented Interfaces:
ParameterMetaData, Wrapper
public class jdbcParameterMetaData extends Object implements ParameterMetaData
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

  • Method Details

    • getParameterClassName

      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.

      Specified by:
      getParameterClassName in interface ParameterMetaData
      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

      public int getParameterCount() throws SQLException
      Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object provides information.

      Specified by:
      getParameterCount in interface ParameterMetaData
      Returns:
      the number of parameters
      Throws:
      SQLException - if a database access error occurs
      Since:
      JDK 1.4, HSQLDB 1.7.2

    • getParameterMode

      public int getParameterMode(int param) throws SQLException
      Retrieves the designated parameter's mode.

      Specified by:
      getParameterMode in interface ParameterMetaData
      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

      public int getParameterType(int param) throws SQLException
      Retrieves the designated parameter's SQL type.

      Specified by:
      getParameterType in interface ParameterMetaData
      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

      public String getParameterTypeName(int param) throws SQLException
      Retrieves the designated parameter's database-specific type name.

      Specified by:
      getParameterTypeName in interface ParameterMetaData
      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

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

      Specified by:
      getPrecision in interface ParameterMetaData
      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

      public int getScale(int param) throws SQLException
      Retrieves the designated parameter's number of digits to right of the decimal point.

      Specified by:
      getScale in interface ParameterMetaData
      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

      public int isNullable(int param) throws SQLException
      Retrieves whether null values are allowed in the designated parameter.

      Specified by:
      isNullable in interface ParameterMetaData
      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

      public boolean isSigned(int param) throws SQLException
      Retrieves whether values for the designated parameter can be signed numbers.

      Specified by:
      isSigned in interface ParameterMetaData
      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

      public String toString()
      Retrieves a String repsentation of this object.

      Overrides:
      toString in class Object
      Returns:
      a String repsentation of this object

    • unwrap

      public <T> T unwrap(Class<T> iface) throws SQLException
      Specified by:
      unwrap in interface Wrapper
      Throws:
      SQLException

    • isWrapperFor

      public boolean isWrapperFor(Class<?> iface) throws SQLException
      Specified by:
      isWrapperFor in interface Wrapper
      Throws:
      SQLException