Class PerFieldDocValuesFormat

Enables per field docvalues support.

Note, when extending this class, the name (Name) is written into the index. In order for the field to be read, the name must resolve to your implementation via ForName(String). This method uses GetDocValuesFormat(String) to resolve format names. See DefaultDocValuesFormatFactory for information about how to implement your own DocValuesFormat.

Files written by each docvalues format have an additional suffix containing the format name. For example, in a per-field configuration instead of _1.dat filenames would look like _1_Lucene40_0.dat.

This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Inheritance
System.Object
DocValuesFormat
PerFieldDocValuesFormat
Inherited Members
Namespace: Lucene.Net.Codecs.PerField
Assembly: Lucene.Net.dll
Syntax
public abstract class PerFieldDocValuesFormat : DocValuesFormat

Constructors

| Improve this Doc View Source

PerFieldDocValuesFormat()

Sole constructor.

Declaration
public PerFieldDocValuesFormat()

Fields

| Improve this Doc View Source

PER_FIELD_FORMAT_KEY

FieldInfo attribute name used to store the format name for each field.

Declaration
public static readonly string PER_FIELD_FORMAT_KEY
Field Value
Type Description
System.String
| Improve this Doc View Source

PER_FIELD_SUFFIX_KEY

FieldInfo attribute name used to store the segment suffix name for each field.

Declaration
public static readonly string PER_FIELD_SUFFIX_KEY
Field Value
Type Description
System.String

Methods

| Improve this Doc View Source

FieldsConsumer(SegmentWriteState)

Declaration
public override sealed DocValuesConsumer FieldsConsumer(SegmentWriteState state)
Parameters
Type Name Description
SegmentWriteState state
Returns
Type Description
DocValuesConsumer
Overrides
| Improve this Doc View Source

FieldsProducer(SegmentReadState)

Declaration
public override sealed DocValuesProducer FieldsProducer(SegmentReadState state)
Parameters
Type Name Description
SegmentReadState state
Returns
Type Description
DocValuesProducer
Overrides
| Improve this Doc View Source

GetDocValuesFormatForField(String)

Returns the doc values format that should be used for writing new segments of field.

The field to format mapping is written to the index, so this method is only invoked when writing, not when reading.

Declaration
public abstract DocValuesFormat GetDocValuesFormatForField(string field)
Parameters
Type Name Description
System.String field
Returns
Type Description
DocValuesFormat

See Also