Package org.firebirdsql.jdbc
Class FBParameterMetaData
- java.lang.Object
-
- org.firebirdsql.jdbc.AbstractFieldMetaData
-
- org.firebirdsql.jdbc.FBParameterMetaData
-
- All Implemented Interfaces:
java.sql.ParameterMetaData,java.sql.Wrapper,FirebirdParameterMetaData
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 aPreparedStatementobject.- Version:
- 1.0
- Author:
- Nickolay Samofatov, Mark Rotteveel
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.firebirdsql.jdbc.AbstractFieldMetaData
AbstractFieldMetaData.ExtendedFieldInfo, AbstractFieldMetaData.FieldKey
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFBParameterMetaData(RowDescriptor rowDescriptor, FBConnection connection)Creates a newFBParameterMetaDatainstance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.Map<AbstractFieldMetaData.FieldKey,AbstractFieldMetaData.ExtendedFieldInfo>getExtendedFieldInfo(FBConnection connection)This method retrieves extended information from the system tables in a database.java.lang.StringgetParameterClassName(int parameter)intgetParameterCount()intgetParameterMode(int parameter)intgetParameterType(int parameter)java.lang.StringgetParameterTypeName(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, unwrap
-
-
-
-
Constructor Detail
-
FBParameterMetaData
protected FBParameterMetaData(RowDescriptor rowDescriptor, FBConnection connection) throws java.sql.SQLException
Creates a newFBParameterMetaDatainstance.- Parameters:
rowDescriptor- a row descriptorconnection- aFBConnectionvalue- Throws:
java.sql.SQLException- if an error occurs
-
-
Method Detail
-
getParameterCount
public int getParameterCount() throws java.sql.SQLException- Specified by:
getParameterCountin interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
isNullable
public int isNullable(int parameter) throws java.sql.SQLException- Specified by:
isNullablein interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
isSigned
public boolean isSigned(int parameter) throws java.sql.SQLException- Specified by:
isSignedin interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
getPrecision
public int getPrecision(int parameter) throws java.sql.SQLExceptionNOTE For
NUMERICandDECIMALthe reported precision is the maximum precision allowed by the underlying storage data type, it is not the declared precision.- Specified by:
getPrecisionin interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
getScale
public int getScale(int parameter) throws java.sql.SQLException- Specified by:
getScalein interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
getParameterType
public int getParameterType(int parameter) throws java.sql.SQLException- Specified by:
getParameterTypein interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
getParameterTypeName
public java.lang.String getParameterTypeName(int parameter) throws java.sql.SQLException- Specified by:
getParameterTypeNamein interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
getParameterClassName
public java.lang.String getParameterClassName(int parameter) throws java.sql.SQLException- Specified by:
getParameterClassNamein interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
getParameterMode
public int getParameterMode(int parameter) throws java.sql.SQLException- Specified by:
getParameterModein interfacejava.sql.ParameterMetaData- Throws:
java.sql.SQLException
-
getExtendedFieldInfo
protected java.util.Map<AbstractFieldMetaData.FieldKey,AbstractFieldMetaData.ExtendedFieldInfo> getExtendedFieldInfo(FBConnection connection) throws java.sql.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:
java.sql.SQLException- if a database error occurs while obtaining extended field information.
-
-