org.apache.ws.jaxme.sqls

Interface Index

All Superinterfaces:
ColumnSet
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(String 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(Column.Name 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(String pName)
Sets the index name.
void
setName(Index.Name pName)
Sets the index name.

Methods inherited from interface org.apache.ws.jaxme.sqls.ColumnSet

getColumns, getTable

Method Details

addColumn

public void addColumn(String pName)

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).

getName

public Index.Name getName()
Returns the index name. Explicit setting of an index name is not required.

isPrimaryKey

public boolean isPrimaryKey()
Returns whether the index is a primary key index.

isUnique

public boolean isUnique()
Returns whether the index is unique.

setName

public void setName(String pName)
Sets the index name. Explicit setting of an index name is not required.

setName

public void setName(Index.Name pName)
Sets the index name. Explicit setting of an index name is not required.