org.axiondb

Interface Index

All Superinterfaces:

TableModificationListener

All Known Implementing Classes:

BaseArrayIndex, BaseBTreeIndex, BaseIndex, IntArrayIndex, IntBTreeIndex, ObjectArrayIndex, ObjectBTreeIndex, StringBTreeIndex

public interface Index
extends TableModificationListener

A database index. (Right now, this class assumes an Index over a single column. Multipart indices will come later.)

TODO: Support expression and/or function e.g UPPER(name)
TODO: Support for Multi column index, very useful for composite keys

Version:

$Revision: 1.22 $ $Date: 2005/12/20 18:32:40 $

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ARRAY
static java.lang.String	BTREE
static java.lang.String	DEFAULT
static java.lang.String	TTREE

Method Summary

Modifier and Type	Method and Description
void	changeRowId(Table table, Row row, int oldId, int newId)
Column	getIndexedColumn() Returns the column I index.
IndexLoader	getIndexLoader()
RowIterator	getInorderRowIterator(RowSource source) Returns a RowIteratorwhich is inorder traversal of keys,
java.lang.String	getName() Returns my name.
RowIterator	getRowIterator(RowSource source, Function fn, java.lang.Object value) Returns a RowIteratorover the indexed rows, limited by the given ComparisonOperator/value pair, using the default sort order.
java.lang.String	getType() Returns my type.
boolean	isUnique() Whether or not I allow duplicate values.
void	save(java.io.File dataDirectory)
void	saveAfterTruncate(java.io.File dataDirectory)
boolean	supportsFunction(Function fn) Returns true iff #getRowIterator(org.axiondb.RowSource,org.axiondb.ComparisonOperator,java.lang.Object) can support the given operator, false otherwise.
void	truncate()

Methods inherited from interface org.axiondb.event.TableModificationListener

columnAdded, constraintAdded, constraintRemoved, rowDeleted, rowInserted, rowUpdated

Field Detail

ARRAY

static final java.lang.String ARRAY

See Also:

Constant Field Values

BTREE

static final java.lang.String BTREE

See Also:

Constant Field Values

DEFAULT

static final java.lang.String DEFAULT

See Also:

Constant Field Values

TTREE

static final java.lang.String TTREE

See Also:

Constant Field Values

Method Detail

changeRowId

void changeRowId(Table table,
                 Row row,
                 int oldId,
                 int newId)
          throws AxionException

Throws:

AxionException

getIndexedColumn

Column getIndexedColumn()

Returns the column I index.

getIndexLoader

IndexLoader getIndexLoader()

getInorderRowIterator

RowIterator getInorderRowIterator(RowSource source)
                           throws AxionException

Returns a RowIteratorwhich is inorder traversal of keys,

Parameters:

source - table/view for which we need to get inorder traversal

Returns:

Throws:

AxionException

getName

java.lang.String getName()

Returns my name.

getRowIterator

RowIterator getRowIterator(RowSource source,
                           Function fn,
                           java.lang.Object value)
                    throws AxionException

Returns a RowIteratorover the indexed rows, limited by the given ComparisonOperator/value pair, using the default sort order.

Parameters:

operator - the ComparisonOperatorto apply

value - the value to compare the indexed column to

Throws:

AxionException

getType

java.lang.String getType()

Returns my type.

isUnique

boolean isUnique()

Whether or not I allow duplicate values.

save

void save(java.io.File dataDirectory)
   throws AxionException

Throws:

AxionException

saveAfterTruncate

void saveAfterTruncate(java.io.File dataDirectory)
                throws AxionException

Throws:

AxionException

supportsFunction

boolean supportsFunction(Function fn)

Returns true iff #getRowIterator(org.axiondb.RowSource,org.axiondb.ComparisonOperator,java.lang.Object) can support the given operator, false otherwise.

truncate

void truncate()
       throws AxionException

Throws:

AxionException