Class Hierarchy        Index

Interface COM.cloudscape.types.IndexDescriptor

public interface IndexDescriptor
extends Serializable
Copyright © 1997-1999, Cloudscape, Inc. All rights reserved.

This interface is used in the column SYS.SYSCONGLOMERATES.DESCRIPTOR. It describes everything about an index except the index name and the table on which the index is defined. That information is available in the columns NAME and TABLEID of the table SYS.SYSCONGLOMERATES.


Variable Index

 o CLASS_NAME

Method Index

 o baseColumnPositions()
Returns an array of column positions in the base table.
 o getKeyColumnPosition(int)
Returns the position of a column within the key (1-based).
 o getKeyColumnPosition(Integer)
Returns the position of a column within the key (1-based).
 o indexType()
Returns the type of the index.
 o isAscending(Integer)
Returns true if the specified column is ascending in the index (1-based).
 o isDescending(Integer)
Returns true if the specified column is descending in the index (1-based).
 o isUnique()
Returns true if the index is unique.
 o numberOfOrderedColumns()
Returns the number of ordered columns.

Variables

 o CLASS_NAME
 public static final String CLASS_NAME

Methods

 o isUnique
 public abstract boolean isUnique()
Returns true if the index is unique.

 o baseColumnPositions
 public abstract int[] baseColumnPositions()
Returns an array of column positions in the base table. Each index column corresponds to a column position in the base table, except the column representing the location of the row in the base table. The returned array holds the column positions in the base table, so, if entry 2 is the number 4, the second column in the index is the fourth column in the table.

 o getKeyColumnPosition
 public abstract Integer getKeyColumnPosition(Integer heapColumnPosition)
Returns the position of a column within the key (1-based). 0 means that the column is not in the key.

 o getKeyColumnPosition
 public abstract int getKeyColumnPosition(int heapColumnPosition)
Returns the position of a column within the key (1-based). 0 means that the column is not in the key. Same as the above method, but it uses int instead of Integer.

 o numberOfOrderedColumns
 public abstract int numberOfOrderedColumns()
Returns the number of ordered columns. In the future, it will be possible to store non-ordered columns in an index. These will be useful for covered queries. The ordered columns will be at the beginning of the index row, and they will be followed by the non-ordered columns. For now, all columns in an index must be ordered.

 o indexType
 public abstract String indexType()
Returns the type of the index. For now, we only support B-Trees, so the value "BTREE" is returned.

 o isAscending
 public abstract boolean isAscending(Integer keyColumnPosition)
Returns true if the specified column is ascending in the index (1-based).

 o isDescending
 public abstract boolean isDescending(Integer keyColumnPosition)
Returns true if the specified column is descending in the index (1-based). In the current release, only ascending columns are supported.


  Class Hierarchy        Index