org.hsqldb.index

Class IndexAVL

java.lang.Object

org.hsqldb.index.IndexAVL

All Implemented Interfaces:

Index, SchemaObject

Direct Known Subclasses:

IndexAVLMemory

public class IndexAVL
extends java.lang.Object
implements Index

Implementation of an AVL tree with parent pointers in nodes. Subclasses of Node implement the tree node objects for memory or disk storage. An Index has a root Node that is linked with other nodes using Java Object references or file pointers, depending on Node implementation.

An Index object also holds information on table columns (in the form of int indexes) that are covered by it.

New class derived from Hypersonic SQL code and enhanced in HSQLDB.

Since:

Hypersonic SQL

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexAVL.IndexRowIterator

Nested classes/interfaces inherited from interface org.hsqldb.index.Index

Index.IndexUse

Nested classes/interfaces inherited from interface org.hsqldb.SchemaObject

SchemaObject.ConstraintTypes, SchemaObject.Deferable, SchemaObject.Nullability, SchemaObject.ParameterModes, SchemaObject.ReferentialAction, SchemaObject.ViewCheckModes

Field Summary

Fields inherited from interface org.hsqldb.index.Index

cachedFactor, emptyArray, emptyUseArray, INDEX_NON_UNIQUE, INDEX_NONE, INDEX_UNIQUE, minimumSelectivity, probeDepth

Fields inherited from interface org.hsqldb.SchemaObject

ASSERTION, CATALOG, CHARSET, COLLATION, COLUMN, CONSTRAINT, CURSOR, DOMAIN, FUNCTION, GRANTEE, INDEX, LABEL, PARAMETER, PROCEDURE, ROUTINE, SCHEMA, SEARCH, SEQUENCE, SERVER, SPECIFIC_ROUTINE, SUBQUERY, TABLE, TRANSITION, TRIGGER, TYPE, VARIABLE, VIEW, WRAPPER

Constructor Summary

Constructors

Constructor and Description
IndexAVL(HsqlNameManager.HsqlName name, long id, TableBase table, int[] columns, boolean[] descending, boolean[] nullsLast, Type[] colTypes, boolean pk, boolean unique, boolean constraint, boolean forward) Constructor declaration

Method Summary

Modifier and Type	Method and Description
Index.IndexUse[]	asArray()
void	checkIndex(PersistentStore store)
int	compareRow(Session session, java.lang.Object[] a, java.lang.Object[] b)
void	compareRowForChange(Session session, java.lang.Object[] a, java.lang.Object[] b, double[] changes)
int	compareRowNonUnique(Session session, java.lang.Object[] a, java.lang.Object[] b, int fieldCount) As above but use the index column data
int	compareRowNonUnique(Session session, java.lang.Object[] a, java.lang.Object[] b, int[] rowColMap) Compares two table rows based on the columns of this index.
int	compareRowNonUnique(Session session, java.lang.Object[] a, java.lang.Object[] b, int[] rowColMap, int fieldCount)
void	compile(Session session, SchemaObject parentObject)
void	delete(Session session, PersistentStore store, Row row)
RowIterator	emptyIterator()
boolean	existsParent(Session session, PersistentStore store, java.lang.Object[] rowdata, int[] rowColMap)
RowIterator	findFirstRow(Session session, PersistentStore store, java.lang.Object[] rowdata) Return the first node equal to the rowdata object.
RowIterator	findFirstRow(Session session, PersistentStore store, java.lang.Object[] rowdata, int[] rowColMap) Return the first node equal to the rowdata object.
RowIterator	findFirstRow(Session session, PersistentStore store, java.lang.Object[] rowdata, int matchCount, int distinctCount, int compareType, boolean reversed, boolean[] map) Return the first node equal to the indexdata object.
RowIterator	findFirstRowNotNull(Session session, PersistentStore store) Finds the first node where the data is not null.
RowIterator	firstRow(PersistentStore store)
RowIterator	firstRow(Session session, PersistentStore store, int distinctCount) Returns the row for the first node of the index
HsqlNameManager.HsqlName	getCatalogName()
long	getChangeTimestamp()
int	getColumnCount() Returns the count of visible columns used
boolean[]	getColumnDesc() Returns the count of visible columns used
int[]	getColumns() Returns the array containing column indexes for index
Type[]	getColumnTypes() Returns the array containing column indexes for index
OrderedHashSet	getComponents()
int[]	getDefaultColumnMap() Returns the array containing 0, 1, ..
int	getIndexOrderValue() Returns a value indicating the order of different types of index in the list of indexes for a table.
HsqlNameManager.HsqlName	getName()
long	getNodeCount(Session session, PersistentStore store)
Grantee	getOwner()
long	getPersistenceId()
int	getPosition()
OrderedHashSet	getReferences()
HsqlNameManager.HsqlName	getSchemaName()
java.lang.String	getSQL()
int	getType()
void	insert(Session session, PersistentStore store, Row row) Insert a node into the index
boolean	isClustered()
boolean	isConstraint() Does this index belong to a constraint?
boolean	isEmpty(PersistentStore store)
boolean	isForward()
boolean	isUnique() Is this a UNIQUE index?
RowIterator	lastRow(Session session, PersistentStore store, int distinctCount) Returns the row for the last node of the index
double[]	searchCost(Session session, PersistentStore store)
void	setClustered(boolean clustered)
void	setPosition(int position)
void	setTable(TableBase table)
long	size(Session session, PersistentStore store) Returns the node count.
long	sizeUnique(PersistentStore store)
void	unlinkNodes(NodeAVL primaryRoot) Removes all links between memory nodes

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IndexAVL

public IndexAVL(HsqlNameManager.HsqlName name,
                long id,
                TableBase table,
                int[] columns,
                boolean[] descending,
                boolean[] nullsLast,
                Type[] colTypes,
                boolean pk,
                boolean unique,
                boolean constraint,
                boolean forward)

Constructor declaration

Parameters:

name - HsqlName of the index

id - persistnece id

table - table of the index

columns - array of column indexes

descending - boolean[]

nullsLast - boolean[]

colTypes - array of column types

pk - if index is for a primary key

unique - is this a unique index

constraint - does this index belonging to a constraint

forward - is this an auto-index for an FK that refers to a table defined after this table

Method Detail

getType

public int getType()

Specified by:

getType in interface SchemaObject

getName

public HsqlNameManager.HsqlName getName()

Specified by:

getName in interface SchemaObject

getCatalogName

public HsqlNameManager.HsqlName getCatalogName()

Specified by:

getCatalogName in interface SchemaObject

getSchemaName

public HsqlNameManager.HsqlName getSchemaName()

Specified by:

getSchemaName in interface SchemaObject

getOwner

public Grantee getOwner()

Specified by:

getOwner in interface SchemaObject

getReferences

public OrderedHashSet getReferences()

Specified by:

getReferences in interface SchemaObject

getComponents

public OrderedHashSet getComponents()

Specified by:

getComponents in interface SchemaObject

compile

public void compile(Session session,
                    SchemaObject parentObject)

Specified by:

compile in interface SchemaObject

getSQL

public java.lang.String getSQL()

Specified by:

getSQL in interface SchemaObject

getChangeTimestamp

public long getChangeTimestamp()

Specified by:

getChangeTimestamp in interface SchemaObject

asArray

public Index.IndexUse[] asArray()

Specified by:

asArray in interface Index

emptyIterator

public RowIterator emptyIterator()

Specified by:

emptyIterator in interface Index

getPosition

public int getPosition()

Specified by:

getPosition in interface Index

setPosition

public void setPosition(int position)

Specified by:

setPosition in interface Index

getPersistenceId

public long getPersistenceId()

Specified by:

getPersistenceId in interface Index

getColumnCount

public int getColumnCount()

Returns the count of visible columns used

Specified by:

getColumnCount in interface Index

isUnique

public boolean isUnique()

Is this a UNIQUE index?

Specified by:

isUnique in interface Index

isConstraint

public boolean isConstraint()

Does this index belong to a constraint?

Specified by:

isConstraint in interface Index

getColumns

public int[] getColumns()

Returns the array containing column indexes for index

Specified by:

getColumns in interface Index

getColumnTypes

public Type[] getColumnTypes()

Returns the array containing column indexes for index

Specified by:

getColumnTypes in interface Index

getColumnDesc

public boolean[] getColumnDesc()

Description copied from interface: Index

Returns the count of visible columns used

Specified by:

getColumnDesc in interface Index

getDefaultColumnMap

public int[] getDefaultColumnMap()

Description copied from interface: Index

Returns the array containing 0, 1, .. column indexes

Specified by:

getDefaultColumnMap in interface Index

getIndexOrderValue

public int getIndexOrderValue()

Returns a value indicating the order of different types of index in the list of indexes for a table. The position of the groups of Indexes in the list in ascending order is as follows: primary key index unique constraint indexes autogenerated foreign key indexes for FK's that reference this table or tables created before this table user created indexes (CREATE INDEX) autogenerated foreign key indexes for FK's that reference tables created after this table Among a group of indexes, the order is based on the order of creation of the index.

Specified by:

getIndexOrderValue in interface Index

Returns:

ordinal value

isForward

public boolean isForward()

Specified by:

isForward in interface Index

setTable

public void setTable(TableBase table)

Specified by:

setTable in interface Index

setClustered

public void setClustered(boolean clustered)

Specified by:

setClustered in interface Index

isClustered

public boolean isClustered()

Specified by:

isClustered in interface Index

size

public long size(Session session,
                 PersistentStore store)

Returns the node count.

Specified by:

size in interface Index

sizeUnique

public long sizeUnique(PersistentStore store)

Specified by:

sizeUnique in interface Index

searchCost

public double[] searchCost(Session session,
                           PersistentStore store)

Specified by:

searchCost in interface Index

getNodeCount

public long getNodeCount(Session session,
                         PersistentStore store)

isEmpty

public boolean isEmpty(PersistentStore store)

Specified by:

isEmpty in interface Index

unlinkNodes

public void unlinkNodes(NodeAVL primaryRoot)

Removes all links between memory nodes

checkIndex

public void checkIndex(PersistentStore store)

Specified by:

checkIndex in interface Index

compareRowNonUnique

public int compareRowNonUnique(Session session,
                               java.lang.Object[] a,
                               java.lang.Object[] b,
                               int[] rowColMap)

Compares two table rows based on the columns of this index. The rowColMap parameter specifies which columns of the other table are to be compared with the colIndex columns of this index. The rowColMap can cover all or only some columns of this index.

Specified by:

compareRowNonUnique in interface Index

Parameters:

session - Session

a - row from another table

rowColMap - column indexes in the other table

b - a full row in this table

Returns:

comparison result, -1,0,+1

compareRowNonUnique

public int compareRowNonUnique(Session session,
                               java.lang.Object[] a,
                               java.lang.Object[] b,
                               int[] rowColMap,
                               int fieldCount)

Specified by:

compareRowNonUnique in interface Index

compareRowNonUnique

public int compareRowNonUnique(Session session,
                               java.lang.Object[] a,
                               java.lang.Object[] b,
                               int fieldCount)

As above but use the index column data

Specified by:

compareRowNonUnique in interface Index

compareRowForChange

public void compareRowForChange(Session session,
                                java.lang.Object[] a,
                                java.lang.Object[] b,
                                double[] changes)

compareRow

public int compareRow(Session session,
                      java.lang.Object[] a,
                      java.lang.Object[] b)

Specified by:

compareRow in interface Index

insert

public void insert(Session session,
                   PersistentStore store,
                   Row row)

Insert a node into the index

Specified by:

insert in interface Index

delete

public void delete(Session session,
                   PersistentStore store,
                   Row row)

Specified by:

delete in interface Index

existsParent

public boolean existsParent(Session session,
                            PersistentStore store,
                            java.lang.Object[] rowdata,
                            int[] rowColMap)

Specified by:

existsParent in interface Index

findFirstRow

public RowIterator findFirstRow(Session session,
                                PersistentStore store,
                                java.lang.Object[] rowdata,
                                int matchCount,
                                int distinctCount,
                                int compareType,
                                boolean reversed,
                                boolean[] map)

Return the first node equal to the indexdata object. The rowdata has the same column mapping as this index.

Specified by:

findFirstRow in interface Index

Parameters:

session - session object

store - store object

rowdata - array containing index column data

matchCount - count of columns to match

compareType - int

reversed - boolean

map - boolean[]

Returns:

iterator

findFirstRow

public RowIterator findFirstRow(Session session,
                                PersistentStore store,
                                java.lang.Object[] rowdata)

Return the first node equal to the rowdata object. The rowdata has the same column mapping as this table.

Specified by:

findFirstRow in interface Index

Parameters:

session - session object

store - store object

rowdata - array containing table row data

Returns:

iterator

findFirstRow

public RowIterator findFirstRow(Session session,
                                PersistentStore store,
                                java.lang.Object[] rowdata,
                                int[] rowColMap)

Return the first node equal to the rowdata object. The rowdata has the column mapping provided in rowColMap.

Specified by:

findFirstRow in interface Index

Parameters:

session - session object

store - store object

rowdata - array containing table row data

rowColMap - int[]

Returns:

iterator

findFirstRowNotNull

public RowIterator findFirstRowNotNull(Session session,
                                       PersistentStore store)

Finds the first node where the data is not null.

Specified by:

findFirstRowNotNull in interface Index

Returns:

iterator

firstRow

public RowIterator firstRow(Session session,
                            PersistentStore store,
                            int distinctCount)

Returns the row for the first node of the index

Specified by:

firstRow in interface Index

Returns:

Iterator for first row

firstRow

public RowIterator firstRow(PersistentStore store)

Specified by:

firstRow in interface Index

lastRow

public RowIterator lastRow(Session session,
                           PersistentStore store,
                           int distinctCount)

Returns the row for the last node of the index

Specified by:

lastRow in interface Index

Returns:

last row