Package org.basex.index.query

Interface EntryIterator

public interface EntryIterator
This interface provides methods for returning index entries.
Author:
BaseX Team 2005-21, BSD License, Christian Gruen

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    count()
    Returns the number of occurrences of the current index entry.
    default byte[]
    get(int i)
    Returns the specified index entry.
    byte[]
    next()
    Returns the next index entry.
    default int
    size()
    Returns the number of results.

  • Method Details

    • next

      byte[] next()
      Returns the next index entry.
      Returns:
      entry or null

    • count

      int count()
      Returns the number of occurrences of the current index entry.
      Returns:
      count

    • get

      default byte[] get(int i)
      Returns the specified index entry. If this method returns tokens, size() needs to be implemented as well.
      Parameters:
      i - index of entry
      Returns:
      entry or null

    • size

      default int size()
      Returns the number of results. If this method returns a positive value, get(int) needs to be implemented as well.
      Returns:
      number of results, or -1 if unknown