com.healthmarketscience.jackcess
Interface Index

All Known Implementing Classes:

IndexImpl

public interface Index

Access database index definition. A Table has a list of Index instances. Indexes can enable fast searches and ordered traversal on a Table (for the indexed columns). These features can be utilized via an IndexCursor.

Author:

James Ahlborn

Nested Class Summary

static interface

Index.Column Information about a Column in an Index

Method Summary

int	getColumnCount()
List<? extends Index.Column>	getColumns()
String	getName()
Index	getReferencedIndex()
Table	getTable()
boolean	isForeignKey()
boolean	isPrimaryKey()
boolean	isRequired() Whether or not values are required for index columns.
boolean	isUnique() Whether or not index entries must be unique.
CursorBuilder	newCursor() Convenience method for constructing a new CursorBuilder for this Index.
boolean	shouldIgnoreNulls() Whether or not null values are actually recorded in the index.

Method Detail

getTable

Table getTable()

getName

String getName()

isPrimaryKey

boolean isPrimaryKey()

isForeignKey

boolean isForeignKey()

getColumnCount

int getColumnCount()

getColumns

List<? extends Index.Column> getColumns()

Returns:

the Columns for this index (unmodifiable)

getReferencedIndex

Index getReferencedIndex()
                         throws IOException

Returns:

the Index referenced by this Index's ForeignKeyReference (if it has one), otherwise null.

Throws:

IOException

shouldIgnoreNulls

boolean shouldIgnoreNulls()

Whether or not null values are actually recorded in the index.

isUnique

boolean isUnique()

Whether or not index entries must be unique.

Some notes about uniqueness:

• Access does not seem to consider multiple null entries invalid for a unique index
• text indexes collapse case, and Access seems to compare only the index entry bytes, therefore two strings which differ only in case will violate the unique constraint

isRequired

boolean isRequired()

Whether or not values are required for index columns.

newCursor

CursorBuilder newCursor()

Convenience method for constructing a new CursorBuilder for this Index.