PostingsFormat

Encodes/decodes terms, postings, and proximity data.

Note, when extending this class, the name (.getName) may written into the index in certain configurations. In order for the segment to be read, the name must resolve to your implementation via .forName. This method uses Java's ServiceLoader (SPI) to resolve format names.

If you implement your own format, make sure that it has a no-arg constructor so SPI can load it.

Parameters

name

Returns this posting format's name. Unique name that's used to retrieve this format when reading the index.

See also

ServiceLoader

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
open override val name: String

Functions

Link copied to clipboard

Writes a new segment

Link copied to clipboard

Reads a segment. NOTE: by the time this call returns, it must hold open any files it will need to use; else, those files may be deleted. Additionally, required files may be deleted during the execution of this call before there is a chance to open them. Under these circumstances an IOException should be thrown by the implementation. IOExceptions are expected and will automatically cause a retry of the segment opening logic with the newly revised segments.

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