Interface IndexDictionary

  • All Known Implementing Classes:
    FSTDictionary

    public interface IndexDictionary
    Immutable stateless index dictionary kept in RAM.

    Implementations must be immutable.

    Use IndexDictionary.Builder to build the IndexDictionary.

    Create a stateful IndexDictionary.Browser to seek a term in this IndexDictionary and get its corresponding block file pointer to the terms block file.

    There is a single implementation of this interface, FSTDictionary. However this interface allows you to plug easily a new kind of index dictionary to experiment and improve the existing one.

    • Method Detail

      • write

        void write​(DataOutput output,
                   BlockEncoder blockEncoder)
            throws java.io.IOException
        Writes this dictionary to the provided output.
        Parameters:
        blockEncoder - The BlockEncoder for specific encoding of this index dictionary; or null if none.
        Throws:
        java.io.IOException