Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.jdbc.EmbedParameterSetMetaData

Modifier and Type	Field and Description
private final int	paramCount
private final ParameterValueSet	pvs
private final DataTypeDescriptor[]	types

Access	Constructor and Description
protected	EmbedParameterSetMetaData(ParameterValueSet pvs, DataTypeDescriptor[] types)

Method Summary

Modifier and Type	Method and Description
private void	checkPosition(int parameterIndex)
public String	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. 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	Returns: the number of parameters getParameterCount() Implements java.sql.ParameterMetaData.getParameterCount. Retrieves the number of parameters in the PreparedStatement object for which this ParameterMetaData object contains information.
public int	Returns: mode of the parameter; one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, or ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown. 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	Returns: SQL type from java.sql.Types 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	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. 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	Returns: precision getPrecision(int - the first parameter is 1, the second is 2, ... param) Implements java.sql.ParameterMetaData.getPrecision. Retrieves the designated parameter's number of decimal digits.
public int	Returns: scale 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	Returns: the nullability status of the given parameter; one of ParameterMetaData.parameterNoNulls, ParameterMetaData.parameterNullable, or ParameterMetaData.parameterNullableUnknown 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	Returns: true if it can be signed numbers 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 implements the interface or directly or indirectly wraps an object that does isWrapperFor(Class<?> a class defining an interface iface) Implements java.sql.Wrapper.isWrapperFor. Returns false unless `iface` is implemented.
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

paramCount	back to summary
private final int paramCount

pvs	back to summary
private final ParameterValueSet pvs

types	back to summary
private final DataTypeDescriptor[] types

Method Detail

checkPosition	back to summary
private void checkPosition(int parameterIndex) throws SQLException

getParameterClassName	back to summary
public String getParameterClassName(int param) throws SQLException Implements 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

getParameterClassName

back to summary

public String getParameterClassName(int param) throws SQLException

Implements 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
public int getParameterCount() Implements 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

getParameterCount

back to summary

public int getParameterCount()

Implements 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

getParameterMode	back to summary
public int getParameterMode(int param) throws SQLException Implements 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

getParameterMode

back to summary

public int getParameterMode(int param) throws SQLException

Implements 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
public int getParameterType(int param) throws SQLException Implements 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

getParameterType

back to summary

public int getParameterType(int param) throws SQLException

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

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. Retrieves the designated parameter's number of decimal digits. 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.

Retrieves the designated parameter's number of decimal digits.

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. Retrieves the designated parameter's number of digits to right of the decimal point. 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.

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

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
public int isNullable(int param) throws SQLException Implements 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

isNullable

back to summary

public int isNullable(int param) throws SQLException

Implements 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
public boolean isSigned(int param) throws SQLException Implements 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 it can be signed numbers Exceptions SQLException: if a database access error occurs

isSigned

back to summary

public boolean isSigned(int param) throws SQLException

Implements 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 it can be signed numbers

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. Returns false unless `iface` is implemented. Parameters iface:Class<?> a class defining an interface Returns:boolean true if this implements the interface or directly or indirectly wraps an object that does Exceptions SQLException: if an error occurs while determining whether this is a wrapper for an object with the given interface.

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

Implements java.sql.Wrapper.isWrapperFor.

Returns false unless iface is implemented.

Parameters

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

Returns:boolean

true if this implements the interface or directly or indirectly wraps an object that does

Exceptions

SQLException:: if an error occurs while determining whether this is a wrapper for an object with the given interface.

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 EmbedParameterSetMetaData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail