er.extensions.migration
Class ERXMigrationIndex

java.lang.Object
  er.extensions.migration.ERXMigrationIndex

public class ERXMigrationIndex
extends java.lang.Object

ERXMigrationIndex provides a wrapper around the definition of an index for migrations.

Author:

mschrag

Constructor Summary

ERXMigrationIndex(java.lang.String name, boolean unique, ERXSQLHelper.ColumnIndex... columns)
Creates a new index reference.

Method Summary

ERXSQLHelper.ColumnIndex[]	columns() Returns the columns being indexed.
boolean	isUnique() Returns whether or not this is a unique index.
java.lang.String	name() Returns the name of this index.

Methods inherited from class java.lang.Object

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

Constructor Detail

ERXMigrationIndex

public ERXMigrationIndex(java.lang.String name,
                         boolean unique,
                         ERXSQLHelper.ColumnIndex... columns)

Creates a new index reference.

Parameters:

name - the name of the index

unique - if true, the index will be a unique index

columns - the columns to index on

Method Detail

name

public java.lang.String name()

Returns the name of this index.

Returns:

the name of this index

columns

public ERXSQLHelper.ColumnIndex[] columns()

Returns the columns being indexed.

Returns:

the columns being indexed

isUnique

public boolean isUnique()

Returns whether or not this is a unique index.

Returns:

whether or not this is a unique index