org.apache.lucene.codecs.lucene40
Class Lucene40DocValuesFormat

java.lang.Object
  extended by org.apache.lucene.codecs.DocValuesFormat
      extended by org.apache.lucene.codecs.lucene40.Lucene40DocValuesFormat
All Implemented Interfaces:
NamedSPILoader.NamedSPI

Deprecated. Only for reading old 4.0 and 4.1 segments

@Deprecated
public class Lucene40DocValuesFormat
extends DocValuesFormat

Lucene 4.0 DocValues format.

Files:

Entries within the compound file:

There are several many types of DocValues with different encodings. From the perspective of filenames, all types store their values in .dat entries within the compound file. In the case of dereferenced/sorted types, the .dat actually contains only the unique values, and an additional .idx file contains pointers to these unique values.

Formats: Data Types: Notes:

Limitations:


Field Summary
static int MAX_BINARY_FIELD_LENGTH
          Deprecated. Maximum length for each binary doc values field.
 
Constructor Summary
Lucene40DocValuesFormat()
          Deprecated. Sole constructor.
 
Method Summary
 DocValuesConsumer fieldsConsumer(SegmentWriteState state)
          Deprecated. Returns a DocValuesConsumer to write docvalues to the index.
 DocValuesProducer fieldsProducer(SegmentReadState state)
          Deprecated. 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
Deprecated. 
Maximum length for each binary doc values field.

See Also:
Constant Field Values
Constructor Detail

Lucene40DocValuesFormat

public Lucene40DocValuesFormat()
Deprecated. 
Sole constructor.

Method Detail

fieldsConsumer

public DocValuesConsumer fieldsConsumer(SegmentWriteState state)
                                 throws IOException
Deprecated. 
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
Deprecated. 
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


Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.