org.apache.lucene.codecs.diskdv

Class DiskDocValuesFormat

java.lang.Object

org.apache.lucene.codecs.DocValuesFormat

org.apache.lucene.codecs.diskdv.DiskDocValuesFormat

All Implemented Interfaces:

NamedSPILoader.NamedSPI

public final class DiskDocValuesFormat
extends DocValuesFormat

DocValues format that keeps most things on disk.

Only things like disk offsets are loaded into ram.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATA_CODEC
static String	DATA_EXTENSION
static String	META_CODEC
static String	META_EXTENSION

Constructor Summary

Constructors

Constructor and Description
DiskDocValuesFormat()

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

DATA_CODEC

public static final String DATA_CODEC

See Also:

Constant Field Values

DATA_EXTENSION

public static final String DATA_EXTENSION

See Also:

Constant Field Values

META_CODEC

public static final String META_CODEC

See Also:

Constant Field Values

META_EXTENSION

public static final String META_EXTENSION

See Also:

Constant Field Values

Constructor Detail

DiskDocValuesFormat

public DiskDocValuesFormat()

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