Module org.apache.lucene.core
Package org.apache.lucene.codecs.lucene90.compressing

Class FieldsIndex

java.lang.Object
org.apache.lucene.codecs.lucene90.compressing.FieldsIndex
All Implemented Interfaces:
Closeable, AutoCloseable, Cloneable
Direct Known Subclasses:
FieldsIndexReader
abstract class FieldsIndex extends Object implements Cloneable, Closeable

  • Constructor Summary

    Constructors
    Constructor
    Description
    FieldsIndex()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    (package private) abstract void
    checkIntegrity()
    Check the integrity of the index.
    abstract FieldsIndex
    clone()
     
    (package private) abstract long
    getBlockID(int docID)
    Get the ID of the block that contains the given docID.
    (package private) abstract long
    getBlockLength(long blockID)
    Get the number of bytes of the block with the given ID.
    (package private) abstract long
    getBlockStartPointer(long blockID)
    Get the start pointer of the block with the given ID.
    (package private) final long
    getStartPointer(int docID)
    Get the start pointer of the block that contains the given docID.

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface java.io.Closeable

    close

  • Constructor Details

    • FieldsIndex

      FieldsIndex()

  • Method Details

    • getBlockID

      abstract long getBlockID(int docID)
      Get the ID of the block that contains the given docID.

    • getBlockStartPointer

      abstract long getBlockStartPointer(long blockID)
      Get the start pointer of the block with the given ID.

    • getBlockLength

      abstract long getBlockLength(long blockID)
      Get the number of bytes of the block with the given ID.

    • getStartPointer

      final long getStartPointer(int docID)
      Get the start pointer of the block that contains the given docID.

    • checkIntegrity

      abstract void checkIntegrity() throws IOException
      Check the integrity of the index.
      Throws:
      IOException

    • clone

      public abstract FieldsIndex clone()
      Overrides:
      clone in class Object