Top Description Fields Constructors Methods
org.hibernate.mapping

public Class Index

extends Object
implements RelationalModel, Exportable, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.hibernate.boot.model.relational.Exportable, org.hibernate.mapping.RelationalModel
Imports
java.io.Serializable, java.util.ArrayList, .Collections, .HashMap, .Iterator, org.hibernate.HibernateException, org.hibernate.boot.Metadata, org.hibernate.boot.model.naming.Identifier, org.hibernate.boot.model.relational.Exportable, .SqlStringGenerationContext, org.hibernate.dialect.Dialect, org.hibernate.engine.spi.Mapping, org.hibernate.internal.util.StringHelper

Deprecated

as a consequence of RelationalModel being deprecated. See corresponding docs for further information.

A relational table index
Author
Gavin King

Field Summary

Modifier and TypeField and Description
private Map<Column, String>
columnOrderMap

private List<Column>
columns

private Identifier
name

private Table
table

Deprecated as a consequence of Table being deprecated.

Constructor Summary

AccessConstructor and Description
public
Index()

Method Summary

Modifier and TypeMethod and Description
public void
addColumn(Column column)

public void
addColumn(Column column, String order)

public void
addColumns(Iterator<E> extraColumns)

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

Deprecated as a consequence of Table being deprecated.
public static String
buildSqlCreateIndexString(Dialect dialect, String name, String tableName, Iterator<Column> columns, Map<Column, String> columnOrderMap, boolean unique)

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

Deprecated as a consequence of Table being deprecated.
public static String
buildSqlDropIndexString(SqlStringGenerationContext context, Table table, String name, String defaultCatalog, String defaultSchema)

Deprecated as a consequence of Table being deprecated.
public static String
buildSqlDropIndexString(String name, String tableName)

public boolean
containsColumn(Column column)

public Iterator<Column>
getColumnIterator()

public Map<Column, String>
getColumnOrderMap()

public int
getColumnSpan()

public String
getExportIdentifier()

Implements org.hibernate.boot.model.relational.Exportable.getExportIdentifier.

Get a unique identifier to make sure we are not exporting the same database structure multiple times.
public String
getName()

public String
getQuotedName(Dialect dialect)

public Table
getTable()

Deprecated as a consequence of Table being deprecated.
public void
setName(String name)

public void
setTable(Table table)

Deprecated as a consequence of Table being deprecated.
public String
sqlConstraintString(Dialect dialect)

public String
sqlCreateString(Mapping mapping, SqlStringGenerationContext context, String defaultCatalog, String defaultSchema)

Implements org.hibernate.mapping.RelationalModel.sqlCreateString.

public String
sqlDropString(SqlStringGenerationContext context, String defaultCatalog, String defaultSchema)

Implements org.hibernate.mapping.RelationalModel.sqlDropString.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

columnOrderMapback to summary
private Map<Column, String> columnOrderMap
columnsback to summary
private List<Column> columns
nameback to summary
private Identifier name
tableback to summary
private Table table

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

Constructor Detail

Indexback to summary
public Index()

Method Detail

addColumnback to summary
public void addColumn(Column column)
addColumnback to summary
public void addColumn(Column column, String order)
addColumnsback to summary
public void addColumns(Iterator<E> extraColumns)
buildSqlCreateIndexStringback to summary
public static String buildSqlCreateIndexString(SqlStringGenerationContext context, String name, Table table, Iterator<Column> columns, Map<Column, String> columnOrderMap, boolean unique, String defaultCatalog, String defaultSchema)

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

buildSqlCreateIndexStringback to summary
public static String buildSqlCreateIndexString(Dialect dialect, String name, String tableName, Iterator<Column> columns, Map<Column, String> columnOrderMap, boolean unique)
buildSqlCreateIndexStringback to summary
public static String buildSqlCreateIndexString(SqlStringGenerationContext context, String name, Table table, Iterator<Column> columns, Map<Column, String> columnOrderMap, boolean unique, Metadata metadata)

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

buildSqlDropIndexStringback to summary
public static String buildSqlDropIndexString(SqlStringGenerationContext context, Table table, String name, String defaultCatalog, String defaultSchema)

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

buildSqlDropIndexStringback to summary
public static String buildSqlDropIndexString(String name, String tableName)
containsColumnback to summary
public boolean containsColumn(Column column)
getColumnIteratorback to summary
public Iterator<Column> getColumnIterator()
getColumnOrderMapback to summary
public Map<Column, String> getColumnOrderMap()
getColumnSpanback to summary
public int getColumnSpan()
getExportIdentifierback to summary
public String getExportIdentifier()

Implements org.hibernate.boot.model.relational.Exportable.getExportIdentifier.

Doc from org.hibernate.boot.model.relational.Exportable.getExportIdentifier.

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

Returns:String

The exporting identifier.

Annotations
@Override
getNameback to summary
public String getName()
getQuotedNameback to summary
public String getQuotedName(Dialect dialect)
getTableback to summary
public Table getTable()

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

setNameback to summary
public void setName(String name)
setTableback to summary
public void setTable(Table table)

Deprecated

as a consequence of Table being deprecated. See corresponding docs for further information.

sqlConstraintStringback to summary
public String sqlConstraintString(Dialect dialect)
sqlCreateStringback to summary
public String sqlCreateString(Mapping mapping, SqlStringGenerationContext context, String defaultCatalog, String defaultSchema) throws HibernateException

Implements org.hibernate.mapping.RelationalModel.sqlCreateString.

Annotations
@Override
sqlDropStringback to summary
public String sqlDropString(SqlStringGenerationContext context, String defaultCatalog, String defaultSchema)

Implements org.hibernate.mapping.RelationalModel.sqlDropString.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override