Package 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 Description IOContextcontextIOContextfor all writes; you should pass this toDirectory.createOutput(String,IOContext).intdelCountOnFlushNumber of deleted documents set while flushing the segment.DirectorydirectoryDirectorywhere this segment will be written to.FieldInfosfieldInfosFieldInfosdescribing all fields in this segment.InfoStreaminfoStreamInfoStreamused for debugging messages.FixedBitSetliveDocsFixedBitSetrecording live documents; this is only set if there is one or more deleted documents.SegmentInfosegmentInfoSegmentInfodescribing this segment.StringsegmentSuffixUnique suffix for any postings files written for this segment.org.apache.lucene.index.BufferedUpdatessegUpdatesDeletes and updates to apply while we are flushing the segment.intsoftDelCountOnFlushNumber of only soft deleted documents set while flushing the segment.
-
Constructor Summary
Constructors Constructor Description SegmentWriteState(SegmentWriteState state, String segmentSuffix)Create a shallow copy ofSegmentWriteStatewith a new segment suffix.SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context)Sole constructor.SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context, String segmentSuffix)Constructor which takes segment suffix.
-
-
-
Field Detail
-
infoStream
public final InfoStream infoStream
InfoStreamused for debugging messages.
-
segmentInfo
public final SegmentInfo segmentInfo
SegmentInfodescribing this segment.
-
fieldInfos
public final FieldInfos fieldInfos
FieldInfosdescribing all fields in this segment.
-
delCountOnFlush
public int delCountOnFlush
Number of deleted documents set while flushing the segment.
-
softDelCountOnFlush
public int softDelCountOnFlush
Number of only soft deleted documents set while flushing the segment.
-
segUpdates
public final org.apache.lucene.index.BufferedUpdates segUpdates
Deletes and updates to apply while we are flushing the segment. A Term is enrolled in here if it was deleted/updated at one point, and it's mapped to the docIDUpto, meaning any docID < docIDUpto containing this term should be deleted/updated.
-
liveDocs
public FixedBitSet liveDocs
FixedBitSetrecording live documents; this is only set if there is one or more deleted documents.
-
segmentSuffix
public final String segmentSuffix
Unique suffix for any postings files written for this segment.PerFieldPostingsFormatsets this for each of the postings formats it wraps. If you create a newPostingsFormatthen any files you write/read must be derived using this suffix (useIndexFileNames.segmentFileName(String,String,String)).Note: the suffix must be either empty, or be a textual suffix contain exactly two parts (separated by underscore), or be a base36 generation.
-
context
public final IOContext context
IOContextfor all writes; you should pass this toDirectory.createOutput(String,IOContext).
-
-
Constructor Detail
-
SegmentWriteState
public SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context)
Sole constructor.
-
SegmentWriteState
public SegmentWriteState(InfoStream infoStream, Directory directory, SegmentInfo segmentInfo, FieldInfos fieldInfos, org.apache.lucene.index.BufferedUpdates segUpdates, IOContext context, String segmentSuffix)
Constructor which takes segment suffix.
-
SegmentWriteState
public SegmentWriteState(SegmentWriteState state, String segmentSuffix)
Create a shallow copy ofSegmentWriteStatewith a new segment suffix.
-
-