EmbedParameterSetMetaData (Apache Derby V10.14 Internals)

java.lang.Object
- org.apache.derby.impl.jdbc.EmbedParameterSetMetaData

All Implemented Interfaces:

java.sql.ParameterMetaData, java.sql.Wrapper
```
public class EmbedParameterSetMetaData
extends java.lang.Object
implements java.sql.ParameterMetaData
```
This class implements the ParameterMetaData interface from JDBC 3.0.

Field Summary

Fields
Modifier and Type Field Description

private int paramCount

private ParameterValueSet pvs

private DataTypeDescriptor[] types
- Fields inherited from interface java.sql.ParameterMetaData
  parameterModeIn, parameterModeInOut, parameterModeOut, parameterModeUnknown, parameterNoNulls, parameterNullable, parameterNullableUnknown

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

Constructor Summary

Constructors
Modifier Constructor Description

protected EmbedParameterSetMetaData(ParameterValueSet pvs, DataTypeDescriptor[] types)

Constructors
Modifier	Constructor	Description
`protected`	`EmbedParameterSetMetaData(ParameterValueSet pvs, DataTypeDescriptor[] types)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private void`	`checkPosition(int parameterIndex)`
`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 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.
`boolean`	`isWrapperFor(java.lang.Class<?> iface)`	Returns false unless `iface` is implemented.
`<T> T`	`unwrap(java.lang.Class<T> iface)`	Returns `this` if this class implements the specified interface.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - pvs
```
private final ParameterValueSet pvs
```
  - types
```
private final DataTypeDescriptor[] types
```
  - paramCount
```
private final int paramCount
```
- Constructor Detail
  - EmbedParameterSetMetaData
```
protected EmbedParameterSetMetaData(ParameterValueSet pvs,
                                    DataTypeDescriptor[] types)
```
- Method Detail
  - getParameterCount
```
public int getParameterCount()
```
    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
  - 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 - - 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:
    
    java.sql.SQLException - if a database access error occurs
  - 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 - - the first parameter is 1, the second is 2, ...
    
    Returns:
    
    true if it can be signed numbers
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - 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 - - the first parameter is 1, the second is 2, ...
    
    Returns:
    
    precision
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - getScale
```
public int getScale(int param)
             throws java.sql.SQLException
```
    Retrieves the designated parameter's number of digits to right of the decimal point.
    
    Specified by:
    
    getScale in interface java.sql.ParameterMetaData
    
    Parameters:
    
    param - - the first parameter is 1, the second is 2, ...
    
    Returns:
    
    scale
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - 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 - - the first parameter is 1, the second is 2, ...
    
    Returns:
    
    SQL type from java.sql.Types
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - 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 - - 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:
    
    java.sql.SQLException - if a database access error occurs
  - 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 - - 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:
    
    java.sql.SQLException - if a database access error occurs
  - 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 - - the first parameter is 1, the second is 2, ...
    
    Returns:
    
    mode of the parameter; one of ParameterMetaData.parameterModeIn, ParameterMetaData.parameterModeOut, or ParameterMetaData.parameterModeInOut ParameterMetaData.parameterModeUnknown.
    
    Throws:
    
    java.sql.SQLException - if a database access error occurs
  - checkPosition
```
private void checkPosition(int parameterIndex)
                    throws java.sql.SQLException
```
    Throws:
    
    java.sql.SQLException
  - isWrapperFor
```
public boolean isWrapperFor(java.lang.Class<?> iface)
                     throws java.sql.SQLException
```
    Returns false unless iface is implemented.
    
    Specified by:
    
    isWrapperFor in interface java.sql.Wrapper
    
    Parameters:
    
    iface - a class defining an interface
    
    Returns:
    
    true if this implements the interface or directly or indirectly wraps an object that does
    
    Throws:
    
    java.sql.SQLException - if an error occurs while determining whether this is a wrapper for an object with the given interface.
  - unwrap
```
public <T> T unwrap(java.lang.Class<T> iface)
             throws java.sql.SQLException
```
    Returns this if this class implements the specified interface.
    
    Specified by:
    
    unwrap in interface java.sql.Wrapper
    
    Parameters:
    
    iface - a class defining an interface
    
    Returns:
    
    an object that implements the interface
    
    Throws:
    
    java.sql.SQLException - if no object is found that implements the interface

Class EmbedParameterSetMetaData

Field Summary

Fields inherited from interface java.sql.ParameterMetaData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

pvs

types

paramCount

Constructor Detail

EmbedParameterSetMetaData

Method Detail

getParameterCount

isNullable

isSigned

getPrecision

getScale

getParameterType

getParameterTypeName

getParameterClassName

getParameterMode

checkPosition

isWrapperFor

unwrap