com.agimatec.sql.meta
Class IndexDescription

java.lang.Object
  com.agimatec.sql.meta.A_IntegrityRuleDescription
      com.agimatec.sql.meta.IndexDescription

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IndexDescription
extends A_IntegrityRuleDescription

Description: Description of an index in the database
Copyright: Copyright (c) 2007
Company: Agimatec GmbH

Author:

Roman Stumm

See Also:

Serialized Form

Field Summary

protected java.lang.String

indexName

Fields inherited from class com.agimatec.sql.meta.A_IntegrityRuleDescription

tableName, tableSpace

Constructor Summary

IndexDescription()

Method Summary

void	addColumn(java.lang.String aCol) add a column in ascending order (=default order)
void	addColumn(java.lang.String aCol, java.lang.String order)
IndexDescription	deepCopy()
java.lang.String	getColumn(int i)
int	getColumnIndex(java.lang.String columnName)
java.util.List<java.lang.String>	getColumns() list of Strings (column names)
int	getColumnSize()
java.lang.String	getIndexName()
java.lang.String	getOrderDirection(int i)
java.lang.String	getOrderDirection(java.lang.String columnName)
boolean	isBitmap()
boolean	isContext()
boolean	isFunctionBased()
boolean	isNoSort()
boolean	isReverse()
boolean	isSameColumns(java.util.List<java.lang.String> otherColumns)
boolean	isUnique()
void	setBitmap(boolean aBitmap)
void	setContext(boolean aContext)
void	setFunctionBased(boolean aFunctionBased)
void	setIndexName(java.lang.String aIndexName)
void	setNoSort(boolean aNoSort)
void	setReverse(boolean aReverse)
void	setUnique(boolean aUnique)
java.lang.String	toString()

Methods inherited from class com.agimatec.sql.meta.A_IntegrityRuleDescription

getTableName, getTableSpace, setTableName, setTableSpace

Methods inherited from class java.lang.Object

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

Field Detail

indexName

protected java.lang.String indexName

Constructor Detail

IndexDescription

public IndexDescription()

Method Detail

deepCopy

public IndexDescription deepCopy()

getIndexName

public java.lang.String getIndexName()

setIndexName

public void setIndexName(java.lang.String aIndexName)

getColumns

public java.util.List<java.lang.String> getColumns()

list of Strings (column names)

Returns:

getColumn

public java.lang.String getColumn(int i)

Specified by:

getColumn in class A_IntegrityRuleDescription

getColumnIndex

public int getColumnIndex(java.lang.String columnName)

addColumn

public void addColumn(java.lang.String aCol)

add a column in ascending order (=default order)

Parameters:

aCol -

addColumn

public void addColumn(java.lang.String aCol,
                      java.lang.String order)

Parameters:

aCol - - column name

order - - OrderClause.ASC or OrderClause.DESC

getOrderDirection

public java.lang.String getOrderDirection(java.lang.String columnName)

getOrderDirection

public java.lang.String getOrderDirection(int i)

Parameters:

i -

Returns:

"ASC" or "DESC"

getColumnSize

public int getColumnSize()

Specified by:

getColumnSize in class A_IntegrityRuleDescription

isUnique

public boolean isUnique()

setUnique

public void setUnique(boolean aUnique)

isReverse

public boolean isReverse()

setReverse

public void setReverse(boolean aReverse)

isNoSort

public boolean isNoSort()

setNoSort

public void setNoSort(boolean aNoSort)

isBitmap

public boolean isBitmap()

setBitmap

public void setBitmap(boolean aBitmap)

isContext

public boolean isContext()

setContext

public void setContext(boolean aContext)

isFunctionBased

public boolean isFunctionBased()

setFunctionBased

public void setFunctionBased(boolean aFunctionBased)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isSameColumns

public boolean isSameColumns(java.util.List<java.lang.String> otherColumns)