org.tentackle.model

Interface Index

All Known Implementing Classes:

IndexImpl

public interface Index

Describes a database index.

Author:

harald

Method Summary

Modifier and Type	Method and Description
List<IndexAttribute>	getAttributes() Gets the index attributes.
String	getComment() Gets the comment.
Entity	getEntity() Gets the entity this index belongs to.
String	getFilterCondition() Gets the optional filter condition.
String	getName() Gets the index name.
String	getName(Entity entity) Gets the index name for given entity.
Line	getSourceLine() Gets the source line.
boolean	isUnique() Returns whether the index is unique.
String	sqlCreateIndex(Backend backend, Entity entity) Creates the index creation sql code.
void	validate() Validates the index.

Method Detail

getEntity

Entity getEntity()

Gets the entity this index belongs to.

Returns:

the entity

getName

String getName()

Gets the index name.

Returns:

the index name (always in lowercase)

getName

String getName(Entity entity)

Gets the index name for given entity.

Parameters:

entity - the entity

Returns:

the effective sql name

getComment

String getComment()

Gets the comment.

Returns:

the comment

isUnique

boolean isUnique()

Returns whether the index is unique.

Returns:

true if unique, else non-unique

getFilterCondition

String getFilterCondition()

Gets the optional filter condition.

Returns:

the condition, null if none

getAttributes

List<IndexAttribute> getAttributes()

Gets the index attributes.

Returns:

the attributes

validate

void validate()
       throws ModelException

Validates the index.

Throws:

ModelException - if validation failed

getSourceLine

Line getSourceLine()

Gets the source line.

Returns:

the source line

sqlCreateIndex

String sqlCreateIndex(Backend backend,
                      Entity entity)

Creates the index creation sql code.

Parameters:

backend - the backend to create sql code for

entity - the entity to create the index for

Returns:

the SQL code