org.apache.lucene.codecs.memory

Class MemoryDocValuesFormat

java.lang.Object

org.apache.lucene.codecs.DocValuesFormat

org.apache.lucene.codecs.memory.MemoryDocValuesFormat

All Implemented Interfaces:

NamedSPILoader.NamedSPI

public class MemoryDocValuesFormat
extends DocValuesFormat

In-memory docvalues format

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_BINARY_FIELD_LENGTH Maximum length for each binary doc values field.

Constructor Summary

Constructors

Constructor and Description
MemoryDocValuesFormat() Calls MemoryDocValuesFormat(PackedInts.DEFAULT)
MemoryDocValuesFormat(float acceptableOverheadRatio) Creates a new MemoryDocValuesFormat with the specified acceptableOverheadRatio for NumericDocValues.

Method Summary

Methods

Modifier and Type	Method and Description
DocValuesConsumer	fieldsConsumer(SegmentWriteState state) Returns a DocValuesConsumer to write docvalues to the index.
DocValuesProducer	fieldsProducer(SegmentReadState state) Returns a DocValuesProducer to read docvalues from the index.

Methods inherited from class org.apache.lucene.codecs.DocValuesFormat

availableDocValuesFormats, forName, getName, reloadDocValuesFormats, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MAX_BINARY_FIELD_LENGTH

public static final int MAX_BINARY_FIELD_LENGTH

Maximum length for each binary doc values field.

See Also:

Constant Field Values

Constructor Detail

MemoryDocValuesFormat

public MemoryDocValuesFormat()

Calls MemoryDocValuesFormat(PackedInts.DEFAULT)

MemoryDocValuesFormat

public MemoryDocValuesFormat(float acceptableOverheadRatio)

Creates a new MemoryDocValuesFormat with the specified acceptableOverheadRatio for NumericDocValues.

Parameters:

acceptableOverheadRatio - compression parameter for numerics. Currently this is only used when the number of unique values is small.

Method Detail

fieldsConsumer

public DocValuesConsumer fieldsConsumer(SegmentWriteState state)
                                 throws IOException

Description copied from class: DocValuesFormat

Returns a DocValuesConsumer to write docvalues to the index.

Specified by:

fieldsConsumer in class DocValuesFormat

Throws:

IOException

fieldsProducer

public DocValuesProducer fieldsProducer(SegmentReadState state)
                                 throws IOException

Description copied from class: DocValuesFormat

Returns a DocValuesProducer to read docvalues from the index.

NOTE: by the time this call returns, it must hold open any files it will need to use; else, those files may be deleted. Additionally, required files may be deleted during the execution of this call before there is a chance to open them. Under these circumstances an IOException should be thrown by the implementation. IOExceptions are expected and will automatically cause a retry of the segment opening logic with the newly revised segments.

Specified by:

fieldsProducer in class DocValuesFormat

Throws:

IOException