Package org.hibernate.mapping

Class Index

java.lang.Object

org.hibernate.mapping.Index

All Implemented Interfaces:

java.io.Serializable, Exportable, RelationalModel

public class Index
extends java.lang.Object
implements RelationalModel, Exportable, java.io.Serializable

A relational table index

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, java.lang.String order)
void	addColumns(java.util.Iterator extraColumns)
static java.lang.String	buildSqlCreateIndexString(SqlStringGenerationContext context, java.lang.String name, Table table, java.util.Iterator<Column> columns, java.util.Map<Column,java.lang.String> columnOrderMap, boolean unique, java.lang.String defaultCatalog, java.lang.String defaultSchema)
static java.lang.String	buildSqlCreateIndexString(SqlStringGenerationContext context, java.lang.String name, Table table, java.util.Iterator<Column> columns, java.util.Map<Column,java.lang.String> columnOrderMap, boolean unique, Metadata metadata)
static java.lang.String	buildSqlCreateIndexString(Dialect dialect, java.lang.String name, java.lang.String tableName, java.util.Iterator<Column> columns, java.util.Map<Column,java.lang.String> columnOrderMap, boolean unique)
static java.lang.String	buildSqlDropIndexString(java.lang.String name, java.lang.String tableName)
static java.lang.String	buildSqlDropIndexString(SqlStringGenerationContext context, Table table, java.lang.String name, java.lang.String defaultCatalog, java.lang.String defaultSchema)
boolean	containsColumn(Column column)
java.util.Iterator<Column>	getColumnIterator()
java.util.Map<Column,java.lang.String>	getColumnOrderMap()
int	getColumnSpan()
java.lang.String	getExportIdentifier()	Get a unique identifier to make sure we are not exporting the same database structure multiple times.
java.lang.String	getName()
java.lang.String	getQuotedName(Dialect dialect)
Table	getTable()
void	setName(java.lang.String name)
void	setTable(Table table)
java.lang.String	sqlConstraintString(Dialect dialect)
java.lang.String	sqlCreateString(Mapping mapping, SqlStringGenerationContext context, java.lang.String defaultCatalog, java.lang.String defaultSchema)
java.lang.String	sqlDropString(SqlStringGenerationContext context, java.lang.String defaultCatalog, java.lang.String defaultSchema)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.mapping.RelationalModel

sqlCreateString, sqlDropString

Constructor Detail

Index

public Index()

Method Detail

sqlCreateString

public java.lang.String sqlCreateString(Mapping mapping,
                                        SqlStringGenerationContext context,
                                        java.lang.String defaultCatalog,
                                        java.lang.String defaultSchema)
                                 throws HibernateException

Specified by:

sqlCreateString in interface RelationalModel

Throws:

HibernateException

buildSqlDropIndexString

public static java.lang.String buildSqlDropIndexString(SqlStringGenerationContext context,
                                                       Table table,
                                                       java.lang.String name,
                                                       java.lang.String defaultCatalog,
                                                       java.lang.String defaultSchema)

buildSqlDropIndexString

public static java.lang.String buildSqlDropIndexString(java.lang.String name,
                                                       java.lang.String tableName)

buildSqlCreateIndexString

public static java.lang.String buildSqlCreateIndexString(SqlStringGenerationContext context,
                                                         java.lang.String name,
                                                         Table table,
                                                         java.util.Iterator<Column> columns,
                                                         java.util.Map<Column,java.lang.String> columnOrderMap,
                                                         boolean unique,
                                                         java.lang.String defaultCatalog,
                                                         java.lang.String defaultSchema)

buildSqlCreateIndexString

public static java.lang.String buildSqlCreateIndexString(Dialect dialect,
                                                         java.lang.String name,
                                                         java.lang.String tableName,
                                                         java.util.Iterator<Column> columns,
                                                         java.util.Map<Column,java.lang.String> columnOrderMap,
                                                         boolean unique)

buildSqlCreateIndexString

public static java.lang.String buildSqlCreateIndexString(SqlStringGenerationContext context,
                                                         java.lang.String name,
                                                         Table table,
                                                         java.util.Iterator<Column> columns,
                                                         java.util.Map<Column,java.lang.String> columnOrderMap,
                                                         boolean unique,
                                                         Metadata metadata)

sqlConstraintString

public java.lang.String sqlConstraintString(Dialect dialect)

sqlDropString

public java.lang.String sqlDropString(SqlStringGenerationContext context,
                                      java.lang.String defaultCatalog,
                                      java.lang.String defaultSchema)

Specified by:

sqlDropString in interface RelationalModel

getTable

public Table getTable()

setTable

public void setTable(Table table)

getColumnSpan

public int getColumnSpan()

getColumnIterator

public java.util.Iterator<Column> getColumnIterator()

getColumnOrderMap

public java.util.Map<Column,java.lang.String> getColumnOrderMap()

addColumn

public void addColumn(Column column)

addColumn

public void addColumn(Column column,
                      java.lang.String order)

addColumns

public void addColumns(java.util.Iterator extraColumns)

containsColumn

public boolean containsColumn(Column column)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getQuotedName

public java.lang.String getQuotedName(Dialect dialect)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getExportIdentifier

public java.lang.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.