Class SegmentReadState

Holder class for common parameters used during read.

Note

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

Inheritance
object
SegmentReadState
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class SegmentReadState

Constructors

SegmentReadState(SegmentReadState, string)

Create a SegmentReadState.

Declaration
public SegmentReadState(SegmentReadState other, string newSegmentSuffix)
Parameters
Type Name Description
SegmentReadState other
string newSegmentSuffix

SegmentReadState(Directory, SegmentInfo, FieldInfos, IOContext, int)

Create a SegmentReadState.

Declaration
public SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor)
Parameters
Type Name Description
Directory dir
SegmentInfo info
FieldInfos fieldInfos
IOContext context
int termsIndexDivisor

SegmentReadState(Directory, SegmentInfo, FieldInfos, IOContext, int, string)

Create a SegmentReadState.

Declaration
public SegmentReadState(Directory dir, SegmentInfo info, FieldInfos fieldInfos, IOContext context, int termsIndexDivisor, string segmentSuffix)
Parameters
Type Name Description
Directory dir
SegmentInfo info
FieldInfos fieldInfos
IOContext context
int termsIndexDivisor
string segmentSuffix

Properties

Context

IOContext to pass to OpenInput(string, IOContext).

Declaration
public IOContext Context { get; }
Property Value
Type Description
IOContext

Directory

Directory where this segment is read from.

Declaration
public Directory Directory { get; }
Property Value
Type Description
Directory

FieldInfos

FieldInfos describing all fields in this segment.

Declaration
public FieldInfos FieldInfos { get; }
Property Value
Type Description
FieldInfos

SegmentInfo

SegmentInfo describing this segment.

Declaration
public SegmentInfo SegmentInfo { get; }
Property Value
Type Description
SegmentInfo

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 new PostingsFormat then any files you write/read must be derived using this suffix (use SegmentFileName(string, string, string)).

Declaration
public string SegmentSuffix { get; }
Property Value
Type Description
string

TermsIndexDivisor

The termInfosIndexDivisor to use, if appropriate (not all PostingsFormats 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
Declaration
public int TermsIndexDivisor { get; set; }
Property Value
Type Description
int