org.basex.index
Interface Index

All Known Implementing Classes:
FTFuzzy, FTIndex, FTTrie, MemValues, PathSummary, Values

public interface Index

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

Author:
Workgroup DBIS, University of Konstanz 2005-10, ISC License, Christian Gruen

Method Summary
 void close()
          Closes the index.
 IndexIterator ids(IndexToken tok)
          Returns an iterator for the index results.
 byte[] info()
          Returns information on the index structure.
 int nrIDs(IndexToken tok)
          Returns the (approximate/estimated) number of ids for the specified token.
 

Method Detail

info

byte[] info()
Returns information on the index structure.

Returns:
info

ids

IndexIterator ids(IndexToken tok)
Returns an iterator for the index results.

Parameters:
tok - token to be found
Returns:
ids

nrIDs

int nrIDs(IndexToken tok)
Returns the (approximate/estimated) number of ids for the specified token.

Parameters:
tok - token to be found
Returns:
number of ids

close

void close()
           throws IOException
Closes the index.

Throws:
IOException - I/O exception