/*
 * Copyright 2004-2019 H2 Group. Multiple-Licensed under the MPL 2.0,
 * and the EPL 1.0 (http://h2database.com/html/license.html).
 * Initial Developer: H2 Group
 */
package org.h2.table;

import org.h2.result.SortOrder;

This represents a column item of an index. This is required because some
indexes support descending sorted columns.
/**
 * This represents a column item of an index. This is required because some
 * indexes support descending sorted columns.
 */
public class IndexColumn {

    
The column name.
/**
     * The column name.
     */
    public String columnName;

    
The column, or null if not set.
/**
     * The column, or null if not set.
     */
    public Column column;

    
The sort type. Ascending (the default) and descending are supported;
nulls can be sorted first or last.
/**
     * The sort type. Ascending (the default) and descending are supported;
     * nulls can be sorted first or last.
     */
    public int sortType = SortOrder.ASCENDING;

    
Appends the specified columns to the specified builder.
Params:
builder – 
           string builder
columns – 
           index columns
alwaysQuote – quote all identifiers
Returns:
the specified string builder/**
     * Appends the specified columns to the specified builder.
     *
     * @param builder
     *            string builder
     * @param columns
     *            index columns
     * @param alwaysQuote quote all identifiers
     * @return the specified string builder
     */
    public static StringBuilder writeColumns(StringBuilder builder, IndexColumn[] columns, boolean alwaysQuote) {
        for (int i = 0, l = columns.length; i < l; i++) {
            if (i > 0) {
                builder.append(", ");
            }
            columns[i].getSQL(builder,  alwaysQuote);
        }
        return builder;
    }

    
Appends the specified columns to the specified builder.
Params:
builder – 
           string builder
columns – 
           index columns
separator – 
           separator
suffix – 
           additional SQL to append after each column
alwaysQuote – quote all identifiers
Returns:
the specified string builder/**
     * Appends the specified columns to the specified builder.
     *
     * @param builder
     *            string builder
     * @param columns
     *            index columns
     * @param separator
     *            separator
     * @param suffix
     *            additional SQL to append after each column
     * @param alwaysQuote quote all identifiers
     * @return the specified string builder
     */
    public static StringBuilder writeColumns(StringBuilder builder, IndexColumn[] columns, String separator,
            String suffix, boolean alwaysQuote) {
        for (int i = 0, l = columns.length; i < l; i++) {
            if (i > 0) {
                builder.append(separator);
            }
            columns[i].getSQL(builder, alwaysQuote).append(suffix);
        }
        return builder;
    }

    
Appends the SQL snippet for this index column to the specified string builder.
Params:
builder – 
           string builder
alwaysQuote – 
           quote all identifiers
Returns:
the specified string builder/**
     * Appends the SQL snippet for this index column to the specified string builder.
     *
     * @param builder
     *            string builder
     * @param alwaysQuote
     *            quote all identifiers
     * @return the specified string builder
     */
    public StringBuilder getSQL(StringBuilder builder, boolean alwaysQuote) {
        SortOrder.typeToString(column.getSQL(builder, alwaysQuote), sortType);
        return builder;
    }

    
Create an array of index columns from a list of columns. The default sort
type is used.
Params:
columns – the column list
Returns:
the index column array/**
     * Create an array of index columns from a list of columns. The default sort
     * type is used.
     *
     * @param columns the column list
     * @return the index column array
     */
    public static IndexColumn[] wrap(Column[] columns) {
        IndexColumn[] list = new IndexColumn[columns.length];
        for (int i = 0; i < list.length; i++) {
            list[i] = new IndexColumn();
            list[i].column = columns[i];
        }
        return list;
    }

    
Map the columns using the column names and the specified table.
Params:
indexColumns – the column list with column names set
table – the table from where to map the column names to columns/**
     * Map the columns using the column names and the specified table.
     *
     * @param indexColumns the column list with column names set
     * @param table the table from where to map the column names to columns
     */
    public static void mapColumns(IndexColumn[] indexColumns, Table table) {
        for (IndexColumn col : indexColumns) {
            col.column = table.getColumn(col.columnName);
        }
    }

    @Override
    public String toString() {
        return getSQL(new StringBuilder("IndexColumn "), false).toString();
    }
}