net.sf.jaxme.sqls
Interface Index

All Superinterfaces:

ColumnSet

All Known Implementing Classes:

IndexImpl

public interface Index

extends ColumnSet

Interface of an index declaration.

Author:

Jochen Wiedmann

Nested Class Summary

static interface

Index.Name

Method Summary

void	addColumn(Column.Name pName) Adds the column with the given name to the index by invoking addColumn(Column).
void	addColumn(Column pColumn) Adds a column to the index.
void	addColumn(java.lang.String pName) Adds the column with the given name to the index by invoking addColumn(Column).
Index.Name	getName() Returns the index name.
boolean	isPrimaryKey() Returns whether the index is a primary key index.
boolean	isUnique() Returns whether the index is unique.
void	setName(Index.Name pName) Sets the index name.
void	setName(java.lang.String pName) Sets the index name.

Methods inherited from interface net.sf.jaxme.sqls.ColumnSet

getColumns, getTable

Method Detail

setName

public void setName(Index.Name pName)

Sets the index name. Explicit setting of an index name is not required.

setName

public void setName(java.lang.String pName)

Sets the index name. Explicit setting of an index name is not required.

getName

public Index.Name getName()

Returns the index name. Explicit setting of an index name is not required.

addColumn

public void addColumn(Column pColumn)

Adds a column to the index. The column must have the same table.

addColumn

public void addColumn(Column.Name pName)

Adds the column with the given name to the index by invoking addColumn(Column).

addColumn

public void addColumn(java.lang.String pName)

Adds the column with the given name to the index by invoking addColumn(Column).

isUnique

public boolean isUnique()

Returns whether the index is unique.

isPrimaryKey

public boolean isPrimaryKey()

Returns whether the index is a primary key index.