org.apache.lucene.codecs.lucene40

Class Lucene40DocValuesFormat

java.lang.Object

org.apache.lucene.codecs.DocValuesFormat

org.apache.lucene.codecs.lucene40.Lucene40DocValuesFormat

public class Lucene40DocValuesFormat
extends DocValuesFormat

Lucene 4.0 DocValues format.

Files:

• .dv.cfs: compound container
• .dv.cfe: compound entries

Entries within the compound file:

• <segment>_<fieldNumber>.dat: data values
• <segment>_<fieldNumber>.idx: index into the .dat for DEREF types

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:

• VAR_INTS .dat --> Header, PackedType, MinValue, DefaultValue, PackedStream
• FIXED_INTS_8 .dat --> Header, ValueSize, Byte^maxdoc
• FIXED_INTS_16 .dat --> Header, ValueSize, Short^maxdoc
• FIXED_INTS_32 .dat --> Header, ValueSize, Int32^maxdoc
• FIXED_INTS_64 .dat --> Header, ValueSize, Int64^maxdoc
• FLOAT_32 .dat --> Header, ValueSize, Float32^maxdoc
• FLOAT_64 .dat --> Header, ValueSize, Float64^maxdoc
• BYTES_FIXED_STRAIGHT .dat --> Header, ValueSize, (Byte * ValueSize)^maxdoc
• BYTES_VAR_STRAIGHT .idx --> Header, MaxAddress, Addresses
• BYTES_VAR_STRAIGHT .dat --> Header, TotalBytes, Addresses, (Byte * variable ValueSize)^maxdoc
• BYTES_FIXED_DEREF .idx --> Header, NumValues, Addresses
• BYTES_FIXED_DEREF .dat --> Header, ValueSize, (Byte * ValueSize)^NumValues
• BYTES_VAR_DEREF .idx --> Header, TotalVarBytes, Addresses
• BYTES_VAR_DEREF .dat --> Header, (LengthPrefix + Byte * variable ValueSize)^NumValues
• BYTES_FIXED_SORTED .idx --> Header, NumValues, Ordinals
• BYTES_FIXED_SORTED .dat --> Header, ValueSize, (Byte * ValueSize)^NumValues
• BYTES_VAR_SORTED .idx --> Header, TotalVarBytes, Addresses, Ordinals
• BYTES_VAR_SORTED .dat --> Header, (Byte * variable ValueSize)^NumValues

Data Types:

• Header --> CodecHeader
• PackedType --> Byte
• MaxAddress, MinValue, DefaultValue --> Int64
• PackedStream, Addresses, Ordinals --> PackedInts
• ValueSize, NumValues --> Int32
• Float32 --> 32-bit float encoded with Float.floatToRawIntBits(float) then written as Int32
• Float64 --> 64-bit float encoded with Double.doubleToRawLongBits(double) then written as Int64
• TotalBytes --> VLong
• TotalVarBytes --> Int64
• LengthPrefix --> Length of the data value as VInt (maximum of 2 bytes)

Notes:

• PackedType is a 0 when compressed, 1 when the stream is written as 64-bit integers.
• Addresses stores pointers to the actual byte location (indexed by docid). In the VAR_STRAIGHT case, each entry can have a different length, so to determine the length, docid+1 is retrieved. A sentinel address is written at the end for the VAR_STRAIGHT case, so the Addresses stream contains maxdoc+1 indices. For the deduplicated VAR_DEREF case, each length is encoded as a prefix to the data itself as a VInt (maximum of 2 bytes).
• Ordinals stores the term ID in sorted order (indexed by docid). In the FIXED_SORTED case, the address into the .dat can be computed from the ordinal as Header+ValueSize+(ordinal*ValueSize) because the byte length is fixed. In the VAR_SORTED case, there is double indirection (docid -> ordinal -> address), but an additional sentinel ordinal+address is always written (so there are NumValues+1 ordinals). To determine the length, ord+1's address is looked up as well.
• BYTES_VAR_STRAIGHT in contrast to other straight variants uses a .idx file to improve lookup perfromance. In contrast to BYTES_VAR_DEREF it doesn't apply deduplication of the document values.

Constructor Summary

Constructors

Constructor and Description
Lucene40DocValuesFormat() Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
PerDocConsumer	docsConsumer(PerDocWriteState state) Consumes (writes) doc values during indexing.
PerDocProducer	docsProducer(SegmentReadState state) Produces (reads) doc values during reading/searching.

Methods inherited from class java.lang.Object

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

Constructor Detail

Lucene40DocValuesFormat

public Lucene40DocValuesFormat()

Sole constructor.

Method Detail

docsConsumer

public PerDocConsumer docsConsumer(PerDocWriteState state)
                            throws IOException

Description copied from class: DocValuesFormat

Consumes (writes) doc values during indexing.

Specified by:

docsConsumer in class DocValuesFormat

Throws:

IOException

docsProducer

public PerDocProducer docsProducer(SegmentReadState state)
                            throws IOException

Description copied from class: DocValuesFormat

Produces (reads) doc values during reading/searching.

Specified by:

docsProducer in class DocValuesFormat

Throws:

IOException