Package org.apache.lucene.index
Class SegmentReadState
java.lang.Object
org.apache.lucene.index.SegmentReadState
Holder class for common parameters used during read.
-
Field Summary
FieldsModifier and TypeFieldDescriptionfinal IOContext
IOContext
to pass toDirectory.openInput(String,IOContext)
.final Directory
Directory
where this segment is read from.final FieldInfos
FieldInfos
describing all fields in this segment.final SegmentInfo
SegmentInfo
describing this segment.final String
Unique suffix for any postings files read for this segment.int
ThetermInfosIndexDivisor
to use, if appropriate (not allPostingsFormat
s support it; in particular the current default does not). -
Constructor Summary
ConstructorsConstructorDescriptionSegmentReadState
(SegmentReadState other, String newSegmentSuffix) Create aSegmentReadState
.SegmentReadState
(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor) Create aSegmentReadState
.SegmentReadState
(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor, String segmentSuffix) Create aSegmentReadState
. -
Method Summary
-
Field Details
-
directory
Directory
where this segment is read from. -
segmentInfo
SegmentInfo
describing this segment. -
fieldInfos
FieldInfos
describing all fields in this segment. -
context
IOContext
to pass toDirectory.openInput(String,IOContext)
. -
termsIndexDivisor
public int termsIndexDivisorThetermInfosIndexDivisor
to use, if appropriate (not allPostingsFormat
s support it; in particular the current default does not).NOTE: if this is < 0, that means "defer terms index load until needed". But if the codec must load the terms index on init (preflex is the only once currently that must do so), then it should negate this value to get the app's terms divisor
-
segmentSuffix
Unique suffix for any postings files read for this segment.PerFieldPostingsFormat
sets this for each of the postings formats it wraps. If you create a newPostingsFormat
then any files you write/read must be derived using this suffix (useIndexFileNames.segmentFileName(String,String,String)
).
-
-
Constructor Details
-
SegmentReadState
public SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor) Create aSegmentReadState
. -
SegmentReadState
public SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor, String segmentSuffix) Create aSegmentReadState
. -
SegmentReadState
Create aSegmentReadState
.
-