Apache Derby Client JDBC Driver 10.17.1.0 · org.apache.derby.client.am.ClientParameterMetaData

Modifier and Type	Field and Description
private ColumnMetaData	columnMetaData_

Access	Constructor and Description
public	ClientParameterMetaData(ColumnMetaData columnMetaData)

Method Summary

Modifier and Type	Method and Description
public String	getParameterClassName(int the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.getParameterClassName. Retrieves the fully-qualified name of the Java class whose instances should be passed to the method `PreparedStatement.setObject`.
public int	getParameterCount() Implements java.sql.ParameterMetaData.getParameterCount. Retrieves the number of parameters in the `PreparedStatement` object for which this `ParameterMetaData` object contains information.
public int	getParameterMode(int the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.getParameterMode. Retrieves the designated parameter's mode.
public int	getParameterType(int the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.getParameterType. Retrieves the designated parameter's SQL type.
public String	getParameterTypeName(int the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.getParameterTypeName. Retrieves the designated parameter's database-specific type name.
public int	getPrecision(int the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.getPrecision. Retrieves the designated parameter's specified column size.
public int	getScale(int the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.getScale. Retrieves the designated parameter's number of digits to right of the decimal point.
public int	isNullable(int the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.isNullable. Retrieves whether null values are allowed in the designated parameter.
public boolean	isSigned(int the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.isSigned. Retrieves whether values for the designated parameter can be signed numbers.
public boolean	Returns: `true` if this instance implements `iface`, or `false` otherwise isWrapperFor(Class<?> a class defining an interface iface) Implements java.sql.Wrapper.isWrapperFor. Check whether this instance wraps an object that implements the interface specified by `iface`.
public <T> T	Returns: an object that implements the interface unwrap(Class<T> a class defining an interface iface) Implements java.sql.Wrapper.unwrap. Returns `this` if this class implements the specified interface.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Detail

getParameterClassName back to summary

getParameterClassName	back to summary
public String getParameterClassName(int param) throws SQLException Implements java.sql.ParameterMetaData.getParameterClassName. Doc from java.sql.ParameterMetaData.getParameterClassName. Retrieves the fully-qualified name of the Java class whose instances should be passed to the method `PreparedStatement.setObject`. Parameters param:int the first parameter is 1, the second is 2, ... Returns:String 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. Exceptions SQLException: if a database access error occurs

public String getParameterClassName(int param) throws SQLException

Implements java.sql.ParameterMetaData.getParameterClassName.

Doc from java.sql.ParameterMetaData.getParameterClassName.

Retrieves the fully-qualified name of the Java class whose instances should be passed to the method PreparedStatement.setObject.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:String

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.

Exceptions

SQLException:: if a database access error occurs

getParameterCount back to summary

getParameterCount	back to summary
public int getParameterCount() throws SQLException Implements java.sql.ParameterMetaData.getParameterCount. Doc from java.sql.ParameterMetaData.getParameterCount. Retrieves the number of parameters in the `PreparedStatement` object for which this `ParameterMetaData` object contains information. Returns:int the number of parameters Exceptions SQLException: if a database access error occurs

public int getParameterCount() throws SQLException

Implements java.sql.ParameterMetaData.getParameterCount.

Doc from java.sql.ParameterMetaData.getParameterCount.

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

Returns:int

the number of parameters

Exceptions

SQLException:: if a database access error occurs

getParameterMode back to summary

getParameterMode	back to summary
public int getParameterMode(int param) throws SQLException Implements java.sql.ParameterMetaData.getParameterMode. Doc from java.sql.ParameterMetaData.getParameterMode. Retrieves the designated parameter's mode. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int mode of the parameter; one of `ParameterMetaData.parameterModeIn`, `ParameterMetaData.parameterModeOut`, or `ParameterMetaData.parameterModeInOut` `ParameterMetaData.parameterModeUnknown`. Exceptions SQLException: if a database access error occurs

public int getParameterMode(int param) throws SQLException

Implements java.sql.ParameterMetaData.getParameterMode.

Doc from java.sql.ParameterMetaData.getParameterMode.

Retrieves the designated parameter's mode.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

mode of the parameter; one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, or ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown.

Exceptions

SQLException:: if a database access error occurs

getParameterType back to summary

getParameterType	back to summary
public int getParameterType(int param) throws SQLException Implements java.sql.ParameterMetaData.getParameterType. Doc from java.sql.ParameterMetaData.getParameterType. Retrieves the designated parameter's SQL type. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int SQL type from `java.sql.Types` Exceptions SQLException: if a database access error occurs

public int getParameterType(int param) throws SQLException

Implements java.sql.ParameterMetaData.getParameterType.

Doc from java.sql.ParameterMetaData.getParameterType.

Retrieves the designated parameter's SQL type.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

SQL type from java.sql.Types

Exceptions

SQLException:: if a database access error occurs

getParameterTypeName	back to summary
public String getParameterTypeName(int param) throws SQLException Implements java.sql.ParameterMetaData.getParameterTypeName. Doc from java.sql.ParameterMetaData.getParameterTypeName. Retrieves the designated parameter's database-specific type name. Parameters param:int the first parameter is 1, the second is 2, ... Returns:String type the name used by the database. If the parameter type is a user-defined type, then a fully-qualified type name is returned. Exceptions SQLException: if a database access error occurs

getParameterTypeName

back to summary

public String getParameterTypeName(int param) throws SQLException

Implements java.sql.ParameterMetaData.getParameterTypeName.

Doc from java.sql.ParameterMetaData.getParameterTypeName.

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

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:String

type the name used by the database. If the parameter type is a user-defined type, then a fully-qualified type name is returned.

Exceptions

SQLException:: if a database access error occurs

getPrecision	back to summary
public int getPrecision(int param) throws SQLException Implements java.sql.ParameterMetaData.getPrecision. Doc from java.sql.ParameterMetaData.getPrecision. 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. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int precision Exceptions SQLException: if a database access error occurs

getPrecision

back to summary

public int getPrecision(int param) throws SQLException

Implements java.sql.ParameterMetaData.getPrecision.

Doc from java.sql.ParameterMetaData.getPrecision.

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.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

precision

Exceptions

SQLException:: if a database access error occurs

getScale	back to summary
public int getScale(int param) throws SQLException Implements java.sql.ParameterMetaData.getScale. Doc from java.sql.ParameterMetaData.getScale. 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. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int scale Exceptions SQLException: if a database access error occurs

getScale

back to summary

public int getScale(int param) throws SQLException

Implements java.sql.ParameterMetaData.getScale.

Doc from java.sql.ParameterMetaData.getScale.

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.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

scale

Exceptions

SQLException:: if a database access error occurs

isNullable back to summary

isNullable	back to summary
public int isNullable(int param) throws SQLException Implements java.sql.ParameterMetaData.isNullable. Doc from java.sql.ParameterMetaData.isNullable. Retrieves whether null values are allowed in the designated parameter. Parameters param:int the first parameter is 1, the second is 2, ... Returns:int the nullability status of the given parameter; one of `ParameterMetaData.parameterNoNulls`, `ParameterMetaData.parameterNullable`, or `ParameterMetaData.parameterNullableUnknown` Exceptions SQLException: if a database access error occurs

public int isNullable(int param) throws SQLException

Implements java.sql.ParameterMetaData.isNullable.

Doc from java.sql.ParameterMetaData.isNullable.

Retrieves whether null values are allowed in the designated parameter.

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:int

the nullability status of the given parameter; one of ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable, or ParameterMetaData.parameterNullableUnknown

Exceptions

SQLException:: if a database access error occurs

isSigned back to summary

isSigned	back to summary
public boolean isSigned(int param) throws SQLException Implements java.sql.ParameterMetaData.isSigned. Doc from java.sql.ParameterMetaData.isSigned. Retrieves whether values for the designated parameter can be signed numbers. Parameters param:int the first parameter is 1, the second is 2, ... Returns:boolean `true` if so; `false` otherwise Exceptions SQLException: if a database access error occurs

public boolean isSigned(int param) throws SQLException

Implements java.sql.ParameterMetaData.isSigned.

Doc from java.sql.ParameterMetaData.isSigned.

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

Parameters

param:int: the first parameter is 1, the second is 2, ...

Returns:boolean

true if so; false otherwise

Exceptions

SQLException:: if a database access error occurs

isWrapperFor back to summary

isWrapperFor	back to summary
public boolean isWrapperFor(Class<?> iface) throws SQLException Implements java.sql.Wrapper.isWrapperFor. Check whether this instance wraps an object that implements the interface specified by `iface`. Parameters iface:Class<?> a class defining an interface Returns:boolean `true` if this instance implements `iface`, or `false` otherwise Exceptions SQLException: if an error occurs while determining if this instance implements `iface`

public boolean isWrapperFor(Class<?> iface) throws SQLException

Implements java.sql.Wrapper.isWrapperFor.

Check whether this instance wraps an object that implements the interface specified by iface.

Parameters

iface:Class<?>: a class defining an interface

Returns:boolean

true if this instance implements iface, or false otherwise

Exceptions

SQLException:: if an error occurs while determining if this instance implements iface

unwrap back to summary

unwrap	back to summary
public <T> T unwrap(Class<T> iface) throws SQLException Implements java.sql.Wrapper.unwrap. Returns `this` if this class implements the specified interface. Parameters <T> Doc from java.sql.Wrapper.unwrap. the type of the class modeled by this Class object iface:Class<T> a class defining an interface Returns:T an object that implements the interface Exceptions SQLException: if no object is found that implements the interface

public <T> T unwrap(Class<T> iface) throws SQLException

Implements java.sql.Wrapper.unwrap.

Returns this if this class implements the specified interface.

Parameters

<T>: Doc from java.sql.Wrapper.unwrap. the type of the class modeled by this Class object
iface:Class<T>: a class defining an interface

Returns:T

an object that implements the interface

Exceptions

SQLException:: if no object is found that implements the interface

public Class ClientParameterMetaData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail