Package org.hibernate.mapping

Class Index

java.lang.Object

org.hibernate.mapping.Index

All Implemented Interfaces:

Serializable, Exportable

public class Index
extends Object
implements Exportable, Serializable

A mapping model object representing an index on a relational database table.

We regularize the semantics of unique constraints on nullable columns: two null values are not considered to be "equal" for the purpose of determining uniqueness, just as specified by ANSI SQL and common sense.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Index()

Method Summary

Modifier and Type	Method	Description
void	addColumn(Column column)
void	addColumn(Column column, String order)
void	addColumns(List<Column> extraColumns)
static String	buildSqlCreateIndexString(SqlStringGenerationContext context, String name, Table table, List<Column> columns, Map<Column,String> columnOrderMap, boolean unique, Metadata metadata)
static String	buildSqlCreateIndexString(Dialect dialect, String name, String tableName, List<Column> columns, Map<Column,String> columnOrderMap, boolean unique)
static String	buildSqlDropIndexString(String name, String tableName)
boolean	containsColumn(Column column)
Iterator<Column>	getColumnIterator()	Deprecated.
Map<Column,String>	getColumnOrderMap()
List<Column>	getColumns()
int	getColumnSpan()
String	getExportIdentifier()	Get a unique identifier to make sure we are not exporting the same database structure multiple times.
String	getName()
String	getQuotedName(Dialect dialect)
Table	getTable()
void	setName(String name)
void	setTable(Table table)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Index

public Index()

Method Detail

buildSqlDropIndexString

public static String buildSqlDropIndexString(String name,
                                             String tableName)

buildSqlCreateIndexString

public static String buildSqlCreateIndexString(Dialect dialect,
                                               String name,
                                               String tableName,
                                               List<Column> columns,
                                               Map<Column,String> columnOrderMap,
                                               boolean unique)

buildSqlCreateIndexString

public static String buildSqlCreateIndexString(SqlStringGenerationContext context,
                                               String name,
                                               Table table,
                                               List<Column> columns,
                                               Map<Column,String> columnOrderMap,
                                               boolean unique,
                                               Metadata metadata)

getTable

public Table getTable()

setTable

public void setTable(Table table)

getColumnSpan

public int getColumnSpan()

getColumnIterator

@Deprecated
public Iterator<Column> getColumnIterator()

Deprecated.

getColumns

public List<Column> getColumns()

getColumnOrderMap

public Map<Column,String> getColumnOrderMap()

addColumn

public void addColumn(Column column)

addColumn

public void addColumn(Column column,
                      String order)

addColumns

public void addColumns(List<Column> extraColumns)

containsColumn

public boolean containsColumn(Column column)

getName

public String getName()

setName

public void setName(String name)

getQuotedName

public String getQuotedName(Dialect dialect)

toString

public String toString()

Overrides:

toString in class Object

getExportIdentifier

public String getExportIdentifier()

Description copied from interface: Exportable

Get a unique identifier to make sure we are not exporting the same database structure multiple times.

Specified by:

getExportIdentifier in interface Exportable

Returns:

The exporting identifier.