Module org.apache.lucene.core

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

Class FieldsIndexWriter

java.lang.Object

org.apache.lucene.codecs.lucene90.compressing.FieldsIndexWriter

All Implemented Interfaces:

Closeable, AutoCloseable

public final class FieldsIndexWriter
extends Object
implements Closeable

Efficient index format for block-based Codecs.

For each block of compressed stored fields, this stores the first document of the block and the start pointer of the block in a DirectMonotonicWriter. At read time, the docID is binary-searched in the DirectMonotonicReader that records doc IDS, and the returned index is used to look up the start pointer in the DirectMonotonicReader that records start pointers.

Field Summary

Fields

Modifier and Type	Field	Description
private final int	blockShift
private final String	codecName
private final Directory	dir
private IndexOutput	docsOut
private final String	extension
private IndexOutput	filePointersOut
private final byte[]	id
private final IOContext	ioContext
private final String	name
private long	previousFP
private final String	suffix
private int	totalChunks
private int	totalDocs
(package private) static final int	VERSION_CURRENT
(package private) static final int	VERSION_START

Constructor Summary

Constructors

Constructor	Description
FieldsIndexWriter(Directory dir, String name, String suffix, String extension, String codecName, byte[] id, int blockShift, IOContext ioContext)

Method Summary

Modifier and Type	Method	Description
void	close()
(package private) void	finish(int numDocs, long maxPointer, IndexOutput metaOut)
(package private) void	writeIndex(int numDocs, long startPointer)

Methods inherited from class java.lang.Object

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

Field Details

VERSION_START

static final int VERSION_START

See Also:

• Constant Field Values

VERSION_CURRENT

static final int VERSION_CURRENT

See Also:

• Constant Field Values

dir

private final Directory dir

name

private final String name

suffix

private final String suffix

extension

private final String extension

codecName

private final String codecName

id

private final byte[] id

blockShift

private final int blockShift

ioContext

private final IOContext ioContext

docsOut

private IndexOutput docsOut

filePointersOut

private IndexOutput filePointersOut

totalDocs

private int totalDocs

totalChunks

private int totalChunks

previousFP

private long previousFP

Constructor Details

FieldsIndexWriter

FieldsIndexWriter(Directory dir,
 String name,
 String suffix,
 String extension,
 String codecName,
 byte[] id,
 int blockShift,
 IOContext ioContext)
           throws IOException

Throws:

IOException

Method Details

writeIndex

void writeIndex(int numDocs,
 long startPointer)
         throws IOException

Throws:

IOException

finish

void finish(int numDocs,
 long maxPointer,
 IndexOutput metaOut)
     throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException