Constructors

Link copied to clipboard
constructor(d: Directory, si: SegmentInfo, segmentSuffix: String, fn: FieldInfos?, context: IOContext, formatName: String, compressionMode: CompressionMode)

Sole constructor.

Types

Link copied to clipboard
object Companion
Link copied to clipboard
class SerializedDocument(val in: DataInput, val length: Int, val numStoredFields: Int)

A serialized document, you need to decode its input in order to get an actual Document.

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
open override fun checkIntegrity()

Checks consistency of this reader.

Link copied to clipboard
open override fun clone(): StoredFieldsReader
Link copied to clipboard
open override fun close()

Close the underlying IndexInputs.

Link copied to clipboard
open override fun document(docID: Int, visitor: StoredFieldVisitor)

Expert: visits the fields of a stored document, for custom processing/loading of each field. If you simply want to load all fields, use .document. If you want to load a subset, use DocumentStoredFieldVisitor.

fun document(docID: Int): Document

Returns the stored fields of the nth Document in this index. This is just sugar for using DocumentStoredFieldVisitor.

fun document(docID: Int, fieldsToLoad: MutableSet<String>): Document

Like .document but only loads the specified fields. Note that this is simply sugar for DocumentStoredFieldVisitor.DocumentStoredFieldVisitor.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun isLoaded(docID: Int): Boolean

Checks if a given docID was loaded in the current block state.

Link copied to clipboard
open override fun prefetch(docID: Int)

Optional method: Give a hint to this StoredFields instance that the given document will be read in the near future. This typically delegates to IndexInput.prefetch and is useful to parallelize I/O across multiple documents.

Link copied to clipboard
open override fun toString(): String