net.sf.colle.sql.schema
Class Index

java.lang.Object
  net.sf.colle.sql.schema.Index

public class Index

extends Object

Model abstraction of an index on a relational table. Created: 21 Feb 2001

Version:

$Revision: 1.4 $, $Date: 2003/07/07 22:34:52 $

Author:

Dwayne Schultz

Constructor Summary

(package private)	Index(String psName, boolean pbUnique, Table pxTable) Constructs an index on a relational table.
(package private)	Index(Table pxTable) Constructs a primary key on a relational table.

Method Summary

(package private) void	appendColumn(Column pxColumn) Appends a column that is part of the index
Iterator	getColumns() Returns all of the columns in this index.
String	getCreateSQL() Returns a complete SQL statement that can be used to create this index.
String	getName() Returns the name of the index.
Table	getTable() Returns the table containing this column.
boolean	isUnique() Returns true if the index is unique.

Methods inherited from class java.lang.Object

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

Constructor Detail

Index

Index(Table pxTable)

Constructs a primary key on a relational table.

Index

Index(String psName,
      boolean pbUnique,
      Table pxTable)

Constructs an index on a relational table.

Method Detail

getName

public String getName()

Returns the name of the index.

getColumns

public Iterator getColumns()

Returns all of the columns in this index.

getTable

public Table getTable()

Returns the table containing this column.

isUnique

public boolean isUnique()

Returns true if the index is unique.

getCreateSQL

public String getCreateSQL()

Returns a complete SQL statement that can be used to create this index.

appendColumn

void appendColumn(Column pxColumn)

Appends a column that is part of the index