org.hibernate.mapping.Index Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
There is a newer version: 7.0.0.Alpha2
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */
package org.hibernate.mapping;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;

import org.hibernate.boot.model.relational.MappedColumn;
import org.hibernate.boot.model.relational.MappedIndex;
import org.hibernate.boot.model.relational.MappedTable;
import org.hibernate.dialect.Dialect;
import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
import org.hibernate.internal.util.StringHelper;
import org.hibernate.metamodel.model.relational.spi.ExportableTable;
import org.hibernate.metamodel.model.relational.spi.PhysicalColumn;
import org.hibernate.metamodel.model.relational.spi.PhysicalNamingStrategy;
import org.hibernate.naming.Identifier;
import org.hibernate.type.spi.TypeConfiguration;

/**
 * A relational table index
 *
 * @author Gavin King
 */
public class Index implements MappedIndex, Serializable {
	private Table table;
	private java.util.List columns = new ArrayList<>();
	private java.util.Map columnOrderMap = new HashMap<>();
	private Identifier name;

	@Override
	public Table getTable() {
		return table;
	}

	@Override
	public void setTable(MappedTable table) {
		this.table = (Table) table;
	}

	@Override
	public int getColumnSpan() {
		return columns.size();
	}

	/**
	 * @deprecated since 6.0, use {#link #getColumns()}
	 */
	@Deprecated
	public Iterator getColumnIterator() {
		return columns.iterator();
	}

	@Override
	public List getColumns() {
		return columns;
	}

	public java.util.Map getColumnOrderMap() {
		return Collections.unmodifiableMap( columnOrderMap );
	}

	@Override
	public void addColumn(Column column) {
		if ( !columns.contains( column ) ) {
			columns.add( column );
		}
	}

	@Override
	public void addColumn(Column column, String order) {
		addColumn( column );
		if ( StringHelper.isNotEmpty( order ) ) {
			columnOrderMap.put( column, order );
		}
	}

	/**
	 * @deprecated since 6.0, use {#link #addColumns(List()}.
	 */
	@Deprecated
	public void addColumns(Iterator extraColumns) {
		while ( extraColumns.hasNext() ) {
			addColumn( (Column) extraColumns.next() );
		}
	}

	@Override
	public void addColumns(List columns) {
		for ( MappedColumn mappedColumn : columns ) {
			addColumn( (Column) mappedColumn );
		}
	}

	public boolean containsColumn(Column column) {
		return columns.contains( column );
	}

	@Override
	public String getName() {
		return name == null ? null : name.getText();
	}

	@Override
	public void setName(String name) {
		this.name = Identifier.toIdentifier( name );
	}

	public String getQuotedName(Dialect dialect) {
		return name == null ? null : name.render( dialect );
	}

	@Override
	public String toString() {
		return getClass().getName() + "(" + getName() + ")";
	}

	public org.hibernate.metamodel.model.relational.spi.Index generateRuntimeIndex(
			ExportableTable runtimeTable,
			PhysicalNamingStrategy namingStrategy,
			JdbcEnvironment jdbcEnvironment, TypeConfiguration typeConfiguration) {
		org.hibernate.metamodel.model.relational.spi.Index index = new org.hibernate.metamodel.model.relational.spi.Index( name, runtimeTable );
		for ( Column column : columns ) {
			PhysicalColumn runtimeColumn = column.generateRuntimeColumn(
					runtimeTable,
					namingStrategy,
					jdbcEnvironment,
					typeConfiguration
			);
			index.addColumn( runtimeColumn );
			if ( columnOrderMap.containsKey( column ) ) {
				index.addColumnOrder( runtimeColumn, columnOrderMap.get( column ) );
			}
		}
		return index;
	}
}