Package org.apache.lucene.index
Class SegmentWriteState
java.lang.Object
org.apache.lucene.index.SegmentWriteState
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
FieldsModifier and TypeFieldDescriptionfinal IOContextIOContextfor all writes; you should pass this toDirectory.createOutput(String,IOContext).intNumber of deleted documents set while flushing the segment.final DirectoryDirectorywhere this segment will be written to.final FieldInfosFieldInfosdescribing all fields in this segment.final InfoStreamInfoStreamused for debugging messages.FixedBitSetrecording live documents; this is only set if there is one or more deleted documents.final SegmentInfoSegmentInfodescribing this segment.final StringUnique suffix for any postings files written for this segment.final org.apache.lucene.index.BufferedUpdatesDeletes and updates to apply while we are flushing the segment.intNumber of only soft deleted documents set while flushing the segment. -
Constructor Summary
ConstructorsConstructorDescriptionSegmentWriteState(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. -
Method Summary
-
Field Details
-
infoStream
InfoStreamused for debugging messages. -
directory
Directorywhere this segment will be written to. -
segmentInfo
SegmentInfodescribing this segment. -
fieldInfos
FieldInfosdescribing all fields in this segment. -
delCountOnFlush
public int delCountOnFlushNumber of deleted documents set while flushing the segment. -
softDelCountOnFlush
public int softDelCountOnFlushNumber of only soft deleted documents set while flushing the segment. -
segUpdates
public final org.apache.lucene.index.BufferedUpdates segUpdatesDeletes 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
FixedBitSetrecording live documents; this is only set if there is one or more deleted documents. -
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
IOContextfor all writes; you should pass this toDirectory.createOutput(String,IOContext).
-
-
Constructor Details
-
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.- See Also:
-
SegmentWriteState
Create a shallow copy ofSegmentWriteStatewith a new segment suffix.
-