Lucene54DocValuesFormat

java.lang.Object
- org.apache.lucene.codecs.DocValuesFormat
- - org.apache.lucene.codecs.lucene54.Lucene54DocValuesFormat

All Implemented Interfaces:

NamedSPILoader.NamedSPI
```
public final class Lucene54DocValuesFormat
extends DocValuesFormat
```
Lucene 5.4 DocValues format.
Encodes the five per-document value types (Numeric,Binary,Sorted,SortedSet,SortedNumeric) with these strategies:
NUMERIC:
- Delta-compressed: per-document integers written as deltas from the minimum value, compressed with bitpacking. For more information, see DirectWriter.
- Table-compressed: when the number of unique values is very small (< 256), and when there are unused "gaps" in the range of values used (such as SmallFloat), a lookup table is written instead. Each per-document entry is instead the ordinal to this table, and those ordinals are compressed with bitpacking (DirectWriter).
- GCD-compressed: when all numbers share a common divisor, such as dates, the greatest common denominator (GCD) is computed, and quotients are stored using Delta-compressed Numerics.
- Monotonic-compressed: when all numbers are monotonically increasing offsets, they are written as blocks of bitpacked integers, encoding the deviation from the expected delta.
- Const-compressed: when there is only one possible non-missing value, only the missing bitset is encoded.
- Sparse-compressed: only documents with a value are stored, and lookups are performed using binary search.
BINARY:
- Fixed-width Binary: one large concatenated byte[] is written, along with the fixed length. Each document's value can be addressed directly with multiplication (docID * length).
- Variable-width Binary: one large concatenated byte[] is written, along with end addresses for each document. The addresses are written as Monotonic-compressed numerics.
- Prefix-compressed Binary: values are written in chunks of 16, with the first value written completely and other values sharing prefixes. chunk addresses are written as Monotonic-compressed numerics. A reverse lookup index is written from a portion of every 1024th term.
SORTED:
- Sorted: a mapping of ordinals to deduplicated terms is written as Binary, along with the per-document ordinals written using one of the numeric strategies above.
SORTED_SET:
- Single: if all documents have 0 or 1 value, then data are written like SORTED.
- SortedSet table: when there are few unique sets of values (< 256) then each set is assigned an id, a lookup table is written and the mapping from document to set id is written using the numeric strategies above.
- SortedSet: a mapping of ordinals to deduplicated terms is written as Binary, an ordinal list and per-document index into this list are written using the numeric strategies above.
SORTED_NUMERIC:
- Single: if all documents have 0 or 1 value, then data are written like NUMERIC.
- SortedSet table: when there are few unique sets of values (< 256) then each set is assigned an id, a lookup table is written and the mapping from document to set id is written using the numeric strategies above.
- SortedNumeric: a value list and per-document index into this list are written using the numeric strategies above.
Files:
1. .dvd: DocValues data
2. .dvm: DocValues metadata

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) static int`	`ALL_LIVE` placeholder for missing offset that means there are no missing values
`(package private) static int`	`ALL_MISSING` placeholder for missing offset that means all values are missing
`(package private) static byte`	`BINARY`
`(package private) static int`	`BINARY_FIXED_UNCOMPRESSED` Uncompressed binary, written directly (fixed length).
`(package private) static int`	`BINARY_PREFIX_COMPRESSED` Compressed binary with shared prefixes
`(package private) static int`	`BINARY_VARIABLE_UNCOMPRESSED` Uncompressed binary, written directly (variable length).
`(package private) static int`	`BLOCK_INTERVAL_COUNT`
`(package private) static int`	`BLOCK_INTERVAL_MASK`
`(package private) static int`	`BLOCK_INTERVAL_SHIFT`
`(package private) static int`	`CONST_COMPRESSED` Compressed with constant value (uses only missing bitset)
`(package private) static java.lang.String`	`DATA_CODEC`
`(package private) static java.lang.String`	`DATA_EXTENSION`
`(package private) static int`	`DELTA_COMPRESSED` Compressed using packed blocks of ints.
`(package private) static int`	`DIRECT_MONOTONIC_BLOCK_SHIFT`
`(package private) static int`	`GCD_COMPRESSED` Compressed by computing the GCD.
`(package private) static int`	`INTERVAL_COUNT`
`(package private) static int`	`INTERVAL_MASK`
`(package private) static int`	`INTERVAL_SHIFT`
`(package private) static java.lang.String`	`META_CODEC`
`(package private) static java.lang.String`	`META_EXTENSION`
`(package private) static int`	`MONOTONIC_BLOCK_SIZE`
`(package private) static int`	`MONOTONIC_COMPRESSED` Compressed with monotonically increasing values
`(package private) static byte`	`NUMERIC`
`(package private) static int`	`REVERSE_INTERVAL_COUNT`
`(package private) static int`	`REVERSE_INTERVAL_MASK`
`(package private) static int`	`REVERSE_INTERVAL_SHIFT`
`(package private) static byte`	`SORTED`
`(package private) static byte`	`SORTED_NUMERIC`
`(package private) static byte`	`SORTED_SET`
`(package private) static int`	`SORTED_SET_TABLE` Compressed giving IDs to unique sets of values: `docId -> setId -> ords`
`(package private) static int`	`SORTED_SINGLE_VALUED` Single-valued sorted set values, encoded as sorted values, so no level of indirection: `docId -> ord`.
`(package private) static int`	`SORTED_WITH_ADDRESSES` Standard storage for sorted set values with 1 level of indirection: `docId -> address -> ord`.
`(package private) static int`	`SPARSE_COMPRESSED` Compressed with sparse arrays.
`(package private) static int`	`TABLE_COMPRESSED` Compressed by giving IDs to unique values.
`(package private) static int`	`VERSION_CURRENT`
`(package private) static int`	`VERSION_START`

Constructor Summary

Constructors
Constructor and Description

Lucene54DocValuesFormat()
Sole Constructor

Constructors
Constructor and Description
`Lucene54DocValuesFormat()` Sole Constructor

Method Summary

All Methods Instance Methods Concrete 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
```
static final java.lang.String DATA_CODEC
```
    See Also:
    
    Constant Field Values
  - DATA_EXTENSION
```
static final java.lang.String DATA_EXTENSION
```
    See Also:
    
    Constant Field Values
  - META_CODEC
```
static final java.lang.String META_CODEC
```
    See Also:
    
    Constant Field Values
  - META_EXTENSION
```
static final java.lang.String META_EXTENSION
```
    See Also:
    
    Constant Field Values
  - VERSION_START
```
static final int VERSION_START
```
    See Also:
    
    Constant Field Values
  - VERSION_CURRENT
```
static final int VERSION_CURRENT
```
    See Also:
    
    Constant Field Values
  - NUMERIC
```
static final byte NUMERIC
```
    See Also:
    
    Constant Field Values
  - BINARY
```
static final byte BINARY
```
    See Also:
    
    Constant Field Values
  - SORTED
```
static final byte SORTED
```
    See Also:
    
    Constant Field Values
  - SORTED_SET
```
static final byte SORTED_SET
```
    See Also:
    
    Constant Field Values
  - SORTED_NUMERIC
```
static final byte SORTED_NUMERIC
```
    See Also:
    
    Constant Field Values
  - INTERVAL_SHIFT
```
static final int INTERVAL_SHIFT
```
    See Also:
    
    Constant Field Values
  - INTERVAL_COUNT
```
static final int INTERVAL_COUNT
```
    See Also:
    
    Constant Field Values
  - INTERVAL_MASK
```
static final int INTERVAL_MASK
```
    See Also:
    
    Constant Field Values
  - REVERSE_INTERVAL_SHIFT
```
static final int REVERSE_INTERVAL_SHIFT
```
    See Also:
    
    Constant Field Values
  - REVERSE_INTERVAL_COUNT
```
static final int REVERSE_INTERVAL_COUNT
```
    See Also:
    
    Constant Field Values
  - REVERSE_INTERVAL_MASK
```
static final int REVERSE_INTERVAL_MASK
```
    See Also:
    
    Constant Field Values
  - BLOCK_INTERVAL_SHIFT
```
static final int BLOCK_INTERVAL_SHIFT
```
    See Also:
    
    Constant Field Values
  - BLOCK_INTERVAL_COUNT
```
static final int BLOCK_INTERVAL_COUNT
```
    See Also:
    
    Constant Field Values
  - BLOCK_INTERVAL_MASK
```
static final int BLOCK_INTERVAL_MASK
```
    See Also:
    
    Constant Field Values
  - DELTA_COMPRESSED
```
static final int DELTA_COMPRESSED
```
    Compressed using packed blocks of ints.
    
    See Also:
    
    Constant Field Values
  - GCD_COMPRESSED
```
static final int GCD_COMPRESSED
```
    Compressed by computing the GCD.
    
    See Also:
    
    Constant Field Values
  - TABLE_COMPRESSED
```
static final int TABLE_COMPRESSED
```
    Compressed by giving IDs to unique values.
    
    See Also:
    
    Constant Field Values
  - MONOTONIC_COMPRESSED
```
static final int MONOTONIC_COMPRESSED
```
    Compressed with monotonically increasing values
    
    See Also:
    
    Constant Field Values
  - CONST_COMPRESSED
```
static final int CONST_COMPRESSED
```
    Compressed with constant value (uses only missing bitset)
    
    See Also:
    
    Constant Field Values
  - SPARSE_COMPRESSED
```
static final int SPARSE_COMPRESSED
```
    Compressed with sparse arrays.
    
    See Also:
    
    Constant Field Values
  - BINARY_FIXED_UNCOMPRESSED
```
static final int BINARY_FIXED_UNCOMPRESSED
```
    Uncompressed binary, written directly (fixed length).
    
    See Also:
    
    Constant Field Values
  - BINARY_VARIABLE_UNCOMPRESSED
```
static final int BINARY_VARIABLE_UNCOMPRESSED
```
    Uncompressed binary, written directly (variable length).
    
    See Also:
    
    Constant Field Values
  - BINARY_PREFIX_COMPRESSED
```
static final int BINARY_PREFIX_COMPRESSED
```
    Compressed binary with shared prefixes
    
    See Also:
    
    Constant Field Values
  - SORTED_WITH_ADDRESSES
```
static final int SORTED_WITH_ADDRESSES
```
    Standard storage for sorted set values with 1 level of indirection: docId -> address -> ord.
    
    See Also:
    
    Constant Field Values
  - SORTED_SINGLE_VALUED
```
static final int SORTED_SINGLE_VALUED
```
    Single-valued sorted set values, encoded as sorted values, so no level of indirection: docId -> ord.
    
    See Also:
    
    Constant Field Values
  - SORTED_SET_TABLE
```
static final int SORTED_SET_TABLE
```
    Compressed giving IDs to unique sets of values: docId -> setId -> ords
    
    See Also:
    
    Constant Field Values
  - ALL_LIVE
```
static final int ALL_LIVE
```
    placeholder for missing offset that means there are no missing values
    
    See Also:
    
    Constant Field Values
  - ALL_MISSING
```
static final int ALL_MISSING
```
    placeholder for missing offset that means all values are missing
    
    See Also:
    
    Constant Field Values
  - MONOTONIC_BLOCK_SIZE
```
static final int MONOTONIC_BLOCK_SIZE
```
    See Also:
    
    Constant Field Values
  - DIRECT_MONOTONIC_BLOCK_SHIFT
```
static final int DIRECT_MONOTONIC_BLOCK_SHIFT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Lucene54DocValuesFormat
```
public Lucene54DocValuesFormat()
```
    Sole Constructor
- Method Detail
  - fieldsConsumer
```
public DocValuesConsumer fieldsConsumer(SegmentWriteState state)
                                 throws java.io.IOException
```
    Description copied from class: DocValuesFormat
    
    Returns a DocValuesConsumer to write docvalues to the index.
    
    Specified by:
    
    fieldsConsumer in class DocValuesFormat
    
    Throws:
    
    java.io.IOException
  - fieldsProducer
```
public DocValuesProducer fieldsProducer(SegmentReadState state)
                                 throws java.io.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:
    
    java.io.IOException

Class Lucene54DocValuesFormat

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

DATA_CODEC

DATA_EXTENSION

META_CODEC

META_EXTENSION

VERSION_START

VERSION_CURRENT

NUMERIC

BINARY

SORTED

SORTED_SET

SORTED_NUMERIC

INTERVAL_SHIFT

INTERVAL_COUNT

INTERVAL_MASK

REVERSE_INTERVAL_SHIFT

REVERSE_INTERVAL_COUNT

REVERSE_INTERVAL_MASK

BLOCK_INTERVAL_SHIFT

BLOCK_INTERVAL_COUNT

BLOCK_INTERVAL_MASK

DELTA_COMPRESSED

GCD_COMPRESSED

TABLE_COMPRESSED

MONOTONIC_COMPRESSED

CONST_COMPRESSED

SPARSE_COMPRESSED

BINARY_FIXED_UNCOMPRESSED

BINARY_VARIABLE_UNCOMPRESSED

BINARY_PREFIX_COMPRESSED

SORTED_WITH_ADDRESSES

SORTED_SINGLE_VALUED

SORTED_SET_TABLE

ALL_LIVE

ALL_MISSING

MONOTONIC_BLOCK_SIZE

DIRECT_MONOTONIC_BLOCK_SHIFT

Constructor Detail

Lucene54DocValuesFormat

Method Detail

fieldsConsumer

fieldsProducer