org.basex.index

Interface Index

All Known Implementing Classes:

DiskValues, FTIndex, MemValues, Names, PathSummary, Resources, UpdatableDiskValues, UpdatableMemValues

public interface Index

This interface defines the methods which have to be implemented by an index structure.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the index.
int	count(IndexToken token) Returns the (approximate/estimated) number of hits for the specified token.
EntryIterator	entries(byte[] prefix) Returns all entries that start with the specified prefix.
byte[]	info() Returns information on the index structure.
IndexIterator	iter(IndexToken token) Returns an iterator for the index results.

Method Detail

info

byte[] info()

Returns information on the index structure.

Returns:

info

entries

EntryIterator entries(byte[] prefix)

Returns all entries that start with the specified prefix.

Parameters:

prefix - prefix

Returns:

entries

iter

IndexIterator iter(IndexToken token)

Returns an iterator for the index results.

Parameters:

token - token to be found

Returns:

sorted pre values for the token

count

int count(IndexToken token)

Returns the (approximate/estimated) number of hits for the specified token.

Parameters:

token - token to be found

Returns:

number of hits

close

void close()
           throws java.io.IOException

Closes the index.

Throws:

java.io.IOException - I/O exception