|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--kodo.jdbc.schema.ReferenceCounter | +--kodo.jdbc.schema.Constraint | +--kodo.jdbc.schema.Index
Represents a database index. This class is closely alligned with the
index information available from DatabaseMetaData
.
Constructor Summary | |
Index()
Default constructor. |
|
Index(String name,
Table table)
Constructor. |
Method Summary | |
void |
addColumn(Column col)
Add a column to the index. |
boolean |
columnsMatch(Column[] idxCols)
Return true if the given columns match the columns of this index. |
int |
compareTo(Object other)
Order on name. |
boolean |
containsColumn(Column col)
Return true if the index includes the given column. |
boolean |
equalsIndex(Index idx)
Indexes are equal if they have the same name, the same columns, and are both unique/not unique. |
Column[] |
getColumns()
Return all the columns the index spans. |
String |
getFullName()
Return the index name, including schema. |
boolean |
isLogical()
Return whether this constraint is a logical constraint only; i.e. |
boolean |
isUnique()
Return true if this is a UNIQUE index. |
boolean |
removeColumn(Column col)
Remove a column from the index. |
void |
setColumns(Column[] cols)
Set the index's columns. |
void |
setUnique(boolean unique)
Set whether this is a UNIQUE index. |
String |
toString()
Returns the index name. |
Methods inherited from class kodo.jdbc.schema.Constraint |
deref, getColumnName, getName, getRefCount, getSchemaName, getTable, getTableName, isDeferred, ref, setColumnName, setDeferred, setName, setSchemaName, setTableName |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public Index()
public Index(String name, Table table)
name
- the name of the indextable
- the table of the indexMethod Detail |
public boolean isLogical()
Constraint
isLogical
in class Constraint
public String getFullName()
getFullName
in class Constraint
public boolean isUnique()
public void setUnique(boolean unique)
public Column[] getColumns()
public void setColumns(Column[] cols)
public void addColumn(Column col)
public boolean removeColumn(Column col)
public boolean containsColumn(Column col)
public int compareTo(Object other)
public String toString()
toString
in class Constraint
public boolean equalsIndex(Index idx)
public boolean columnsMatch(Column[] idxCols)
|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |