java.lang.Object
org.firebirdsql.jdbc.AbstractFieldMetaData
org.firebirdsql.jdbc.FBParameterMetaData
- All Implemented Interfaces:
ParameterMetaData,Wrapper,FirebirdParameterMetaData
@InternalApi
public class FBParameterMetaData
extends AbstractFieldMetaData
implements FirebirdParameterMetaData
An object that can be used to get information about the types and properties for each parameter marker in a
PreparedStatement object.
This class is internal API of Jaybird. Future versions may radically change, move, or make inaccessible this type.
For the public API, refer to the ParameterMetaData and FirebirdParameterMetaData interfaces.
- Author:
- Nickolay Samofatov, Mark Rotteveel
-
Nested Class Summary
Nested classes/interfaces inherited from class org.firebirdsql.jdbc.AbstractFieldMetaData
AbstractFieldMetaData.ExtendedFieldInfo, AbstractFieldMetaData.FieldKey -
Field Summary
Fields inherited from interface java.sql.ParameterMetaData
parameterModeIn, parameterModeInOut, parameterModeOut, parameterModeUnknown, parameterNoNulls, parameterNullable, parameterNullableUnknown -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedFBParameterMetaData(RowDescriptor rowDescriptor, FBConnection connection) Creates a newFBParameterMetaDatainstance. -
Method Summary
Modifier and TypeMethodDescriptiongetExtendedFieldInfo(FBConnection connection) This method retrieves extended information from the system tables in a database.getParameterClassName(int parameter) intintgetParameterMode(int parameter) intgetParameterType(int parameter) getParameterTypeName(int parameter) intgetPrecision(int parameter) intgetScale(int parameter) intisNullable(int parameter) booleanisSigned(int parameter) Methods inherited from class org.firebirdsql.jdbc.AbstractFieldMetaData
estimateFixedPrecision, getExtFieldInfo, getFieldClassName, getFieldCount, getFieldDescriptor, getFieldType, getFieldTypeName, getPrecisionInternal, getRowDescriptor, getScaleInternal, isSignedInternal, isWrapperFor, unwrapMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
Constructor Details
-
FBParameterMetaData
protected FBParameterMetaData(RowDescriptor rowDescriptor, FBConnection connection) throws SQLException Creates a newFBParameterMetaDatainstance.- Parameters:
rowDescriptor- a row descriptorconnection- aFBConnectionvalue- Throws:
SQLException- if an error occurs
-
-
Method Details
-
getParameterCount
- Specified by:
getParameterCountin interfaceParameterMetaData- Throws:
SQLException
-
isNullable
- Specified by:
isNullablein interfaceParameterMetaData- Throws:
SQLException
-
isSigned
- Specified by:
isSignedin interfaceParameterMetaData- Throws:
SQLException
-
getPrecision
NOTE For
NUMERICandDECIMALthe reported precision is the maximum precision allowed by the underlying storage data type, it is not the declared precision.- Specified by:
getPrecisionin interfaceParameterMetaData- Throws:
SQLException
-
getScale
- Specified by:
getScalein interfaceParameterMetaData- Throws:
SQLException
-
getParameterType
- Specified by:
getParameterTypein interfaceParameterMetaData- Throws:
SQLException
-
getParameterTypeName
- Specified by:
getParameterTypeNamein interfaceParameterMetaData- Throws:
SQLException
-
getParameterClassName
- Specified by:
getParameterClassNamein interfaceParameterMetaData- Throws:
SQLException
-
getParameterMode
- Specified by:
getParameterModein interfaceParameterMetaData- Throws:
SQLException
-
getExtendedFieldInfo
protected Map<AbstractFieldMetaData.FieldKey,AbstractFieldMetaData.ExtendedFieldInfo> getExtendedFieldInfo(FBConnection connection) throws SQLException This method retrieves extended information from the system tables in a database. Since this method is expensive, use it with care.FBParameterMetaDatadoes not support extended field info, so it always returns an empty Map.- Specified by:
getExtendedFieldInfoin classAbstractFieldMetaData- Returns:
- mapping between
AbstractFieldMetaData.FieldKeyinstances andAbstractFieldMetaData.ExtendedFieldInfoinstances, or an empty Map if the metadata implementation does not support extended info. - Throws:
SQLException- if a database error occurs while obtaining extended field information.
-