org.hibernate.mapping
Class Index

java.lang.Object
  org.hibernate.mapping.Index

All Implemented Interfaces:

java.io.Serializable, RelationalModel

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

A relational table index

Author:

Gavin King

See Also:

Serialized Form

Constructor Summary

Index()

Method Summary

void	addColumn(Column column)
void	addColumns(java.util.Iterator extraColumns)
static java.lang.String	buildSqlCreateIndexString(Dialect dialect, java.lang.String name, Table table, java.util.Iterator columns, boolean unique, java.lang.String defaultCatalog, java.lang.String defaultSchema)
static java.lang.String	buildSqlDropIndexString(Dialect dialect, Table table, java.lang.String name, java.lang.String defaultCatalog, java.lang.String defaultSchema)
boolean	containsColumn(Column column)
java.util.Iterator	getColumnIterator()
int	getColumnSpan()
java.lang.String	getName()
Table	getTable()
void	setName(java.lang.String name)
void	setTable(Table table)
java.lang.String	sqlConstraintString(Dialect dialect)
java.lang.String	sqlCreateString(Dialect dialect, Mapping mapping, java.lang.String defaultCatalog, java.lang.String defaultSchema)
java.lang.String	sqlDropString(Dialect dialect, 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

Constructor Detail

Index

public Index()

Method Detail

sqlCreateString

public java.lang.String sqlCreateString(Dialect dialect,
                                        Mapping mapping,
                                        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(Dialect dialect,
                                                       Table table,
                                                       java.lang.String name,
                                                       java.lang.String defaultCatalog,
                                                       java.lang.String defaultSchema)

buildSqlCreateIndexString

public static java.lang.String buildSqlCreateIndexString(Dialect dialect,
                                                         java.lang.String name,
                                                         Table table,
                                                         java.util.Iterator columns,
                                                         boolean unique,
                                                         java.lang.String defaultCatalog,
                                                         java.lang.String defaultSchema)

sqlConstraintString

public java.lang.String sqlConstraintString(Dialect dialect)

sqlDropString

public java.lang.String sqlDropString(Dialect dialect,
                                      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 getColumnIterator()

addColumn

public void addColumn(Column column)

addColumns

public void addColumns(java.util.Iterator extraColumns)

containsColumn

public boolean containsColumn(Column column)

Parameters:

column -

Returns:

true if this constraint already contains a column with same name.

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object