org.firebirdsql.jdbc.FBParameterMetaData Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaybird Show documentation
JDBC Driver for the Firebird RDBMS
The newest version!
/*
 * Firebird Open Source JDBC Driver
 *
 * Distributable under LGPL license.
 * You may obtain a copy of the License at http://www.gnu.org/copyleft/lgpl.html
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * LGPL License for more details.
 *
 * This file was created by members of the firebird development team.
 * All individual contributions remain the Copyright (C) of those
 * individuals.  Contributors to this file are either listed here or
 * can be obtained from a source control history command.
 *
 * All rights reserved.
 */
package org.firebirdsql.jdbc;

import org.firebirdsql.gds.ng.fields.RowDescriptor;
import org.firebirdsql.util.InternalApi;

import java.sql.ParameterMetaData;
import java.sql.SQLException;
import java.util.Collections;
import java.util.Map;

/**
 * An object that can be used to get information about the types and properties for each parameter marker in a
 * {@link java.sql.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 {@link ParameterMetaData} and {@link FirebirdParameterMetaData} interfaces.
 * 
 *
 * @author Nickolay Samofatov
 * @author Mark Rotteveel
 * @version 1.0
 */
@SuppressWarnings("RedundantThrows")
@InternalApi
public class FBParameterMetaData extends AbstractFieldMetaData implements FirebirdParameterMetaData {

    /**
     * Creates a new {@code FBParameterMetaData} instance.
     *
     * @param rowDescriptor
     *         a row descriptor
     * @param connection
     *         a FBConnection value
     * @throws SQLException
     *         if an error occurs
     */
    protected FBParameterMetaData(RowDescriptor rowDescriptor, FBConnection connection) throws SQLException {
        super(rowDescriptor, connection);
    }

    @Override
    public int getParameterCount() throws SQLException {
        return getFieldCount();
    }

    @Override
    public int isNullable(int parameter) throws SQLException {
        return (getFieldDescriptor(parameter).getType() & 1) == 1
                ? ParameterMetaData.parameterNullable
                : ParameterMetaData.parameterNoNulls;
    }

    @Override
    public boolean isSigned(int parameter) throws SQLException {
        return isSignedInternal(parameter);
    }

    /**
     * {@inheritDoc}
     * 
     * NOTE For NUMERIC and DECIMAL the reported precision is the maximum precision
     * allowed by the underlying storage data type, it is not the declared precision.
     * 
     */
    @Override
    public int getPrecision(int parameter) throws SQLException {
        return getPrecisionInternal(parameter);
    }

    @Override
    public int getScale(int parameter) throws SQLException {
        return getScaleInternal(parameter);
    }

    @Override
    public int getParameterType(int parameter) throws SQLException {
        return getFieldType(parameter);
    }

    @Override
    public String getParameterTypeName(int parameter) throws SQLException {
        return getFieldTypeName(parameter);
    }

    @Override
    public String getParameterClassName(int parameter) throws SQLException {
        return getFieldClassName(parameter);
    }

    @Override
    public int getParameterMode(int parameter) throws SQLException {
        return ParameterMetaData.parameterModeIn;
    }

    /**
     * {@inheritDoc}
     * 
     * FBParameterMetaData does not support extended field info, so it always returns an empty Map.
     * 
     */
    @Override
    protected Map getExtendedFieldInfo(FBConnection connection) throws SQLException {
        return Collections.emptyMap();
    }
}