com.microsoft.sqlserver.jdbc.SQLServerMetaData Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mssql-jdbc Show documentation
Microsoft JDBC Driver for SQL Server.
There is a newer version: 12.8.1.jre11
/*
 * Microsoft JDBC Driver for SQL Server
 * 
 * Copyright(c) Microsoft Corporation All rights reserved.
 * 
 * This program is made available under the terms of the MIT License. See the LICENSE file in the project root for more information.
 */

package com.microsoft.sqlserver.jdbc;

import java.text.MessageFormat;

/**
 * 
 * This class represents metadata for a column. It is used in the ISQLServerDataRecord interface to pass column metadata to the table-valued
 * parameter.
 * 
 */
public class SQLServerMetaData {

    String columnName = null;
    int javaSqlType;
    int precision = 0;
    int scale = 0;
    boolean useServerDefault = false;
    boolean isUniqueKey = false;
    SQLServerSortOrder sortOrder = SQLServerSortOrder.Unspecified;
    int sortOrdinal;

    static final int defaultSortOrdinal = -1;

    /**
     * Creates a new SQLServerMetaData
     * 
     * @param columnName
     *            the name of the column
     * @param sqlType
     *            the SQL type of the column
     */
    public SQLServerMetaData(String columnName,
            int sqlType) {
        this.columnName = columnName;
        this.javaSqlType = sqlType;
    }

    /**
     * creates a new SQLServerMetaData
     * 
     * @param columnName
     *            the name of the column
     * @param sqlType
     *            the SQL type of the column
     * @param precision
     *            the precision of the column
     * @param scale
     *            the scale of the column
     */
    public SQLServerMetaData(String columnName,
            int sqlType,
            int precision,
            int scale) {
        this.columnName = columnName;
        this.javaSqlType = sqlType;
        this.precision = precision;
        this.scale = scale;
    }

    /**
     * Creates a new SQLServerMetaData
     * 
     * @param columnName
     *            the name of the column
     * @param sqlType
     *            the sql type of the column
     * @param precision
     *            the precision of the column
     * @param scale
     *            the scale of the column
     * @param useServerDefault
     *            specifies if this column should use the default server value; Default value is false.
     * @param isUniqueKey
     *            indicates if the column in the table-valued parameter is unique; Default value is false.
     * @param sortOrder
     *            indicates the sort order for a column; Default value is SQLServerSortOrder.Unspecified.
     * @param sortOrdinal
     *            specifies ordinal of the sort column; sortOrdinal starts from 0; Default value is -1.
     * @throws SQLServerException
     *             when an error occurs
     */
    public SQLServerMetaData(String columnName,
            int sqlType,
            int precision,
            int scale,
            boolean useServerDefault,
            boolean isUniqueKey,
            SQLServerSortOrder sortOrder,
            int sortOrdinal) throws SQLServerException {
        this.columnName = columnName;
        this.javaSqlType = sqlType;
        this.precision = precision;
        this.scale = scale;
        this.useServerDefault = useServerDefault;
        this.isUniqueKey = isUniqueKey;
        this.sortOrder = sortOrder;
        this.sortOrdinal = sortOrdinal;
        validateSortOrder();
    }

    /**
     * Initializes a new instance of SQLServerMetaData from another SQLServerMetaData object.
     * 
     * @param sqlServerMetaData
     *            the object passed to initialize a new instance of SQLServerMetaData
     */
    public SQLServerMetaData(SQLServerMetaData sqlServerMetaData) {
        this.columnName = sqlServerMetaData.columnName;
        this.javaSqlType = sqlServerMetaData.javaSqlType;
        this.precision = sqlServerMetaData.precision;
        this.scale = sqlServerMetaData.scale;
        this.useServerDefault = sqlServerMetaData.useServerDefault;
        this.isUniqueKey = sqlServerMetaData.isUniqueKey;
        this.sortOrder = sqlServerMetaData.sortOrder;
        this.sortOrdinal = sqlServerMetaData.sortOrdinal;
    }

    /**
     * 
     * @return Retrieves the column name.
     */
    public String getColumName() {
        return columnName;
    }

    /**
     * 
     * @return Retrieves the java sql type.
     */
    public int getSqlType() {
        return javaSqlType;
    }

    /**
     * 
     * @return retrieves the precision of the type passed to the column.
     */
    public int getPrecision() {
        return precision;
    }

    /**
     * 
     * @return retrieves the scale of the type passed to the column.
     */
    public int getScale() {
        return scale;
    }

    /**
     * 
     * @return returns whether the column uses the default server value.
     */
    public boolean useServerDefault() {
        return useServerDefault;
    }

    /**
     * 
     * @return retrieves the whether the column is unique.
     */
    public boolean isUniqueKey() {
        return isUniqueKey;
    }

    /**
     * 
     * @return retrieves the sort order.
     */
    public SQLServerSortOrder getSortOrder() {
        return sortOrder;
    }

    /**
     * 
     * @return retrieves the sort ordinal.
     */
    public int getSortOrdinal() {
        return sortOrdinal;
    }

    void validateSortOrder() throws SQLServerException {
        // should specify both sort order and ordinal, or neither
        if ((SQLServerSortOrder.Unspecified == sortOrder) != (defaultSortOrdinal == sortOrdinal)) {
            MessageFormat form = new MessageFormat(SQLServerException.getErrString("R_TVPMissingSortOrderOrOrdinal"));
            throw new SQLServerException(form.format(new Object[] {sortOrder, sortOrdinal}), null, 0, null);
        }
    }
}