schemacrawler.schema

Interface Index

All Superinterfaces:

AttributedObject, Comparable<NamedObject>, ContainedObject<Table>, DatabaseObject, DefinedObject, DependantObject<Table>, DescribedObject, Iterable<IndexColumn>, NamedObject, Serializable, TypedObject<IndexType>

All Known Subinterfaces:

PrimaryKey

public interface Index
extends DependantObject<Table>, TypedObject<IndexType>, DefinedObject, Iterable<IndexColumn>

Represents an index on a database table.

Author:

Sualeh Fatehi

Method Summary

Modifier and Type	Method and Description
int	getCardinality() Gets the cardinality.
List<IndexColumn>	getColumns() Gets the list of columns in ordinal order.
IndexType	getIndexType() Gets the index type.
int	getPages() Gets the pages.
default IndexType	getType() Gets the type of the object.
boolean	isUnique() If the index is unique.
Optional<? extends IndexColumn>	lookupColumn(String name) Gets a column by unqualified name.

Methods inherited from interface schemacrawler.schema.DependantObject

getShortName, isParentPartial

Methods inherited from interface schemacrawler.schema.DatabaseObject

getSchema

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getLookupKey, getName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.AttributedObject

getAttribute, getAttribute, getAttributes, hasAttribute, lookupAttribute, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.DescribedObject

getRemarks, hasRemarks

Methods inherited from interface schemacrawler.schema.ContainedObject

getParent

Methods inherited from interface schemacrawler.schema.DefinedObject

getDefinition, hasDefinition

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getCardinality

int getCardinality()

Gets the cardinality. When the index type is statistic, then this is the number of rows in the table; otherwise, it is the number of unique values in the index.

Returns:

Cardinality

getColumns

List<IndexColumn> getColumns()

Gets the list of columns in ordinal order.

Returns:

Columns of the index.

getIndexType

IndexType getIndexType()

Gets the index type.

Returns:

Index type.

getPages

int getPages()

Gets the pages. When the index type is statistic, then this is the number of pages used for the table, otherwise it is the number of pages used for the current index.

Returns:

Pages

getType

default IndexType getType()

Gets the type of the object. Synonym for another getter method.

Specified by:

getType in interface TypedObject<IndexType>

Returns:

Type of the object

See Also:

TypedObject.getType()

isUnique

boolean isUnique()

If the index is unique.

Returns:

If the index is unique

lookupColumn

Optional<? extends IndexColumn> lookupColumn(String name)

Gets a column by unqualified name.

Parameters:

name - Unqualified name

Returns:

Column.