org.apache.lucene.index

Class SegmentWriteState

java.lang.Object

org.apache.lucene.index.SegmentWriteState

public class SegmentWriteState
extends Object

Holder class for common parameters used during write.

WARNING: This API is experimental and might change in incompatible ways in the next release.

Field Summary

Fields

Modifier and Type	Field and Description
IOContext	context
int	delCountOnFlush
Directory	directory
FieldInfos	fieldInfos
InfoStream	infoStream
MutableBits	liveDocs
org.apache.lucene.index.BufferedDeletes	segDeletes
SegmentInfo	segmentInfo
String	segmentSuffix
int	termIndexInterval Expert: The fraction of terms in the "dictionary" which should be stored in RAM.

Constructor Summary

Constructors

Constructor and Description
SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, int termIndexInterval, org.apache.lucene.index.BufferedDeletes segDeletes, IOContext context)
SegmentWriteState(SegmentWriteState state, String segmentSuffix) Create a shallow SegmentWriteState copy final a format ID

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

infoStream

public final InfoStream infoStream

directory

public final Directory directory

segmentInfo

public final SegmentInfo segmentInfo

fieldInfos

public final FieldInfos fieldInfos

delCountOnFlush

public int delCountOnFlush

segDeletes

public final org.apache.lucene.index.BufferedDeletes segDeletes

liveDocs

public MutableBits liveDocs

segmentSuffix

public final String segmentSuffix

termIndexInterval

public int termIndexInterval

Expert: The fraction of terms in the "dictionary" which should be stored in RAM. Smaller values use more memory, but make searching slightly faster, while larger values use less memory and make searching slightly slower. Searching is typically not dominated by dictionary lookup, so tweaking this is rarely useful.

context

public final IOContext context

Constructor Detail

SegmentWriteState

public SegmentWriteState(InfoStream infoStream,
                 Directory directory,
                 SegmentInfo segmentInfo,
                 FieldInfos fieldInfos,
                 int termIndexInterval,
                 org.apache.lucene.index.BufferedDeletes segDeletes,
                 IOContext context)

SegmentWriteState

public SegmentWriteState(SegmentWriteState state,
                 String segmentSuffix)

Create a shallow SegmentWriteState copy final a format ID