org.apache.ws.jaxme.sqls

Interface Index

public interface Index extends ColumnSet

Interface of an index declaration.

Author: Jochen Wiedmann

Nested Class Summary
static interfaceIndex.Name
Method Summary
voidaddColumn(Column pColumn)

Adds a column to the index.

voidaddColumn(Column.Name pName)

Adds the column with the given name to the index by invoking {@link #addColumn(Column)}.

voidaddColumn(String pName)

Adds the column with the given name to the index by invoking {@link #addColumn(Column)}.

Index.NamegetName()

Returns the index name.

booleanisPrimaryKey()

Returns whether the index is a primary key index.

booleanisUnique()

Returns whether the index is unique.

voidsetName(Index.Name pName)

Sets the index name.

voidsetName(String pName)

Sets the index name.

Method Detail

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 {@link #addColumn(Column)}.

addColumn

public void addColumn(String pName)

Adds the column with the given name to the index by invoking {@link #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(Index.Name pName)

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

setName

public void setName(String pName)

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