|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.torque.engine.database.model.Index
Information about indices of a table.
Field Summary | |
private static boolean |
DEBUG
enables debug output |
private java.util.List |
indexColumns
|
private java.lang.String |
indexName
|
private Table |
parentTable
|
Constructor Summary | |
|
Index()
Creates a new instance with default characteristics (no name or parent table, small column list size allocation, non-unique). |
protected |
Index(Table table,
java.util.List indexColumns)
Creates a new instance for the list of columns composing an index. |
Method Summary | |
void |
addColumn(org.xml.sax.Attributes attrib)
Adds a new column to an index. |
private void |
createName()
|
java.lang.String |
getColumnList()
Return a comma delimited string of the columns which compose this index. |
protected java.util.List |
getColumnNames()
Returns the list of names of the columns referenced by this index. |
java.util.List |
getColumns()
Return the list of local columns. |
java.lang.String |
getIndexColumnList()
Deprecated. Use getColumnList() instead. |
java.util.List |
getIndexColumns()
Deprecated. Use getColumns() instead. |
java.lang.String |
getIndexName()
Deprecated. Use getName() instead. |
boolean |
getIsUnique()
Deprecated. Use isUnique() instead. |
java.lang.String |
getName()
Gets the name of this index. |
Table |
getTable()
Get the parent Table of the index |
java.lang.String |
getTableName()
Returns the Name of the table the index is in |
boolean |
isUnique()
Returns the uniqueness of this index. |
void |
loadFromXML(org.xml.sax.Attributes attrib)
Imports index from an XML specification |
void |
setIndexName(java.lang.String name)
Deprecated. Use setName(String name) instead. |
void |
setName(java.lang.String name)
Set the name of this index. |
void |
setTable(Table parent)
Set the parent Table of the index |
java.lang.String |
toString()
String representation of the index. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
private static final boolean DEBUG
private java.lang.String indexName
private Table parentTable
private java.util.List indexColumns
Constructor Detail |
public Index()
protected Index(Table table, java.util.List indexColumns) throws EngineException
Index()
.
table
- The table this index is associated with.indexColumns
- The list of Column
objects which
make up this index. Cannot be empty.
EngineException
- Error generating name.Index()
Method Detail |
private void createName() throws EngineException
EngineException
public void loadFromXML(org.xml.sax.Attributes attrib)
public boolean getIsUnique()
isUnique()
public boolean isUnique()
public java.lang.String getIndexName()
getName()
public java.lang.String getName()
public void setIndexName(java.lang.String name)
setName(String name)
public void setName(java.lang.String name)
public void setTable(Table parent)
public Table getTable()
public java.lang.String getTableName()
public void addColumn(org.xml.sax.Attributes attrib)
public java.lang.String getIndexColumnList()
getColumnList()
public java.lang.String getColumnList()
public java.util.List getIndexColumns()
getColumns()
public java.util.List getColumns()
protected java.util.List getColumnNames()
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |