vortex.sql
Class vortexParameterMetaData

java.lang.Object
  vortex.sql.vortexParameterMetaData

All Implemented Interfaces:

java.sql.ParameterMetaData

public class vortexParameterMetaData
extends java.lang.Object
implements java.sql.ParameterMetaData

A ParameterMetaData object is used to get information about the type and properties of the parameters in a PreparedStatement object.

Field Summary

Fields inherited from interface java.sql.ParameterMetaData

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

Constructor Summary

vortexParameterMetaData(dbChannel db, java.lang.String sql)

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 the 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

vortexParameterMetaData

public vortexParameterMetaData(dbChannel db,
                               java.lang.String sql)
                        throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

getParameterClassName

public 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.

Specified by:

getParameterClassName in interface java.sql.ParameterMetaData

Parameters:

param - parameter index

Returns:

the Java class name

Throws:

java.sql.SQLException - thrown in the event the dbFetch fails

getParameterCount

public int getParameterCount()
                      throws java.sql.SQLException

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

Specified by:

getParameterCount in interface java.sql.ParameterMetaData

Returns:

the number of parameters

Throws:

java.sql.SQLException - thrown in the event the DB action fails

getParameterMode

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

Retrieves the designated parameter's mode.

Specified by:

getParameterMode in interface java.sql.ParameterMetaData

Parameters:

param - parameter index

Returns:

one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, ParameterMetaData.parameterModeInOut, or ParameterMetaData.parameterModeUnknown for SQL statements that return nothing

Throws:

java.sql.SQLException - thrown in the event the DB action fails

getParameterType

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

Retrieves the designated parameter's SQL type.

Specified by:

getParameterType in interface java.sql.ParameterMetaData

Parameters:

param - parameter index

Returns:

SQL type from java.sql.Types

Throws:

java.sql.SQLException - thrown in the event the DB action fails

getParameterTypeName

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

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

Specified by:

getParameterTypeName in interface java.sql.ParameterMetaData

Parameters:

param - parameter index

Returns:

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 - thrown in the event the DB action fails

getPrecision

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

Retrieves the designated parameter's number of decimal digits.

Specified by:

getPrecision in interface java.sql.ParameterMetaData

Parameters:

param - parameter index

Returns:

precision

Throws:

java.sql.SQLException - thrown in the event the DB action fails

getScale

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

Retrieves the designated parameter's number of digits to the right of the decimal point.

Specified by:

getScale in interface java.sql.ParameterMetaData

Parameters:

param - parameter index

Returns:

scale

Throws:

java.sql.SQLException - thrown in the event the DB action fails

isNullable

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

Retrieves whether null values are allowed in the designated parameter.

Specified by:

isNullable in interface java.sql.ParameterMetaData

Parameters:

param - parameter index

Returns:

the nullabilty status of the given parameter; one of parameterMetaData.parameterNoNulls, parameterMetaData.parameterNullable, or parameterMetaData.parameterNullableUnknown.

Throws:

java.sql.SQLException - thrown in the event the DB action fails

isSigned

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

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

Specified by:

isSigned in interface java.sql.ParameterMetaData

Parameters:

param - parameter index

Returns:

true if so, false otherwise.

Throws:

java.sql.SQLException - thrown in the event the DB action fails