Package org.apache.empire.db

Class DBExpressionIndex

java.lang.Object

org.apache.empire.db.DBObject

org.apache.empire.db.DBIndex

org.apache.empire.db.DBExpressionIndex

public class DBExpressionIndex
extends DBIndex

This class allows to create an expression based index

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.empire.db.DBIndex

DBIndex.DBIndexType

Constructor Summary

Constructors

Constructor	Description
DBExpressionIndex(String name, boolean unique, DBColumnExpr... columnExpressions)	Constructs a DBExpresionIndex
DBExpressionIndex(String name, DBIndex.DBIndexType type, DBColumnExpr... columnExpressions)	Constructs a DBExpresionIndex

Method Summary

Modifier and Type	Method	Description
boolean	contains(DBColumn col)	Checks if this index contains the column col
int	getColumnPos(DBColumn col)	Gets the position of a specified DBColumn object.
final DBDatabase	getDatabase()	Returns the database object to which this object belongs to.
DBColumnExpr[]	getExpressions()	Returns the columnExpressions belonging to this index.

Methods inherited from class org.apache.empire.db.DBIndex

compareColumns, getColumn, getColumnCount, getColumns, getFullName, getName, getOptions, getTable, getType, setOptions

Methods inherited from class org.apache.empire.db.DBObject

checkParamNull

Methods inherited from class java.lang.Object

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

Constructor Details

DBExpressionIndex

public DBExpressionIndex(String name,
 DBIndex.DBIndexType type,
 DBColumnExpr... columnExpressions)

Constructs a DBExpresionIndex

Parameters:

name - the index name

type - the index type

columnExpressions - an array of one or more column expressions of the index

DBExpressionIndex

public DBExpressionIndex(String name,
 boolean unique,
 DBColumnExpr... columnExpressions)

Constructs a DBExpresionIndex

Parameters:

name - the index name

unique - flag whether the index is unique

columnExpressions - the index columns Overload for convenience

Method Details

getDatabase

public final DBDatabase getDatabase()

Description copied from class: DBObject

Returns the database object to which this object belongs to. For the database object itself this function will return the this pointer.

Overrides:

getDatabase in class DBIndex

Returns:

the database object

getExpressions

public DBColumnExpr[] getExpressions()

Returns the columnExpressions belonging to this index.

Overrides:

getExpressions in class DBIndex

Returns:

the columnExpressions belonging to this index

contains

public boolean contains(DBColumn col)

Checks if this index contains the column col

Overrides:

contains in class DBIndex

Parameters:

col - the column

Returns:

true if this index contains this column

getColumnPos

public int getColumnPos(DBColumn col)

Gets the position of a specified DBColumn object.

Overrides:

getColumnPos in class DBIndex

Parameters:

col - the column

Returns:

the position or -1 if the column was not found