Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.basex.index
Class Index

    java.lang.Object
      org.basex.index.Index

Direct Known Subclasses:
  FTFuzzy, FTTrie, MemValues, Values

    public abstract class Index

extends java.lang.Object

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

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

Constructor Summary
`Index()`

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

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### Index

    public Index()

Method Detail

### info

    public abstract byte[] info()

  Returns information on the index structure.

  Returns:
    info

### ids

    public abstract IndexIterator ids(IndexToken tok)

  Returns an iterator for the index results.

  Parameters:
    `tok` - token to be found
  Returns:
    ids

### nrIDs

    public abstract 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

    public void close()
               throws java.io.IOException

  Close the index.

  Throws:
    `java.io.IOException` - in case of write errors

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD