| org.netbeans.modules.sql.framework.model.Index
All known Subclasses: org.netbeans.modules.sql.framework.model.impl.IndexImpl,
| Index | | public interface Index extends Cloneable(Code) | | Interface describing index metadata for data sources providing information
in a database or database-like format. Implementing classes must support the
Cloneable interface.
author:
Jonathan Giron |
| Method Summary | |
| public boolean | contains(String columnName)
Indicates whether the column represented by the given columnName
is indexed by this instance. | | public boolean | contains(DBColumn col)
Indicates whether this column is indexed by this instance. | | public int | getCardinality()
| | public int | getColumnCount()
Gets count of indexed columns. | | public String | getColumnName(int iColumn)
Gets name of the column positioned as the iColumn-th column, if any,
indexed by this Index. | | public List<String> | getColumnNames()
Gets read-only List of Strings (in sequential order) representing names
of indexed columns. | | public String | getName()
Gets (optional) name of this index. | | public DBTable | getParent()
Gets reference to ETLTable that owns this Index. | | public int | getSequence(DBColumn col)
Gets ordinal (base-one) sequence of the given DBColumn in this Index,
provided it exists. | | public String | getSortSequence()
| | public int | getType()
Gets type of index. | | public boolean | isUnique()
|
| contains | | public boolean contains(String columnName)(Code) | | Indicates whether the column represented by the given columnName
is indexed by this instance.
Parameters:
columnName - name of column to test true if columnName is indexed by this instance, false otherwise. |
| contains | | public boolean contains(DBColumn col)(Code) | | Indicates whether this column is indexed by this instance.
Parameters:
col - DBColumn to test true if columnName is indexed by this instance, false otherwise. |
| getCardinality | | public int getCardinality()(Code) | | Gets cardinality of this index
value representing cardinality of the index |
| getColumnCount | | public int getColumnCount()(Code) | | Gets count of indexed columns.
column count |
| getColumnName | | public String getColumnName(int iColumn)(Code) | | Gets name of the column positioned as the iColumn-th column, if any,
indexed by this Index. iColumn ranges from 1 (first column)
to n, where n is the total number of columns indexed.
Parameters:
iColumn - index of column whose name is requested name of iColumn-th indexed column, or null if no column exists at the given position. |
| getColumnNames | | public List<String> getColumnNames()(Code) | | Gets read-only List of Strings (in sequential order) representing names
of indexed columns.
List of names of indexed columns |
| getName | | public String getName()(Code) | | Gets (optional) name of this index.
Index name, or null if none was defined |
| getParent | | public DBTable getParent()(Code) | | Gets reference to ETLTable that owns this Index.
parent ETLTable |
| getSequence | | public int getSequence(DBColumn col)(Code) | | Gets ordinal (base-one) sequence of the given DBColumn in this Index,
provided it exists. The return value ranges from 1 (first column) to n,
where n is the total number of columns indexed, or -1 if col
is not indexed by this instance.
Parameters:
col - DBColumn whose sequence is requested ordinal sequence of col, starting with 1 if the column is the first in a composite index; -1 if col is not indexed by this instance |
| getSortSequence | | public String getSortSequence()(Code) | | Gets sort order, if any, used in this index
String indicating sort order; 'A' for ascending, 'D' for descending, null if no sort order is established |
| isUnique | | public boolean isUnique()(Code) | | Indicates whether this index enforces uniqueness
true if index enforces uniqueness, false otherwise |
|
|