Package org.apache.lucene.codecs.lucene45

Class Lucene45DocValuesConsumer

java.lang.Object

org.apache.lucene.codecs.DocValuesConsumer

org.apache.lucene.codecs.lucene45.Lucene45DocValuesConsumer

All Implemented Interfaces:

Closeable, AutoCloseable

public class Lucene45DocValuesConsumer
extends DocValuesConsumer
implements Closeable

writer for Lucene45DocValuesFormat

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BINARY_FIXED_UNCOMPRESSED	Uncompressed binary, written directly (fixed length).
static final int	BINARY_PREFIX_COMPRESSED	Compressed binary with shared prefixes
static final int	BINARY_VARIABLE_UNCOMPRESSED	Uncompressed binary, written directly (variable length).
static final int	DELTA_COMPRESSED	Compressed using packed blocks of ints.
static final int	GCD_COMPRESSED	Compressed by computing the GCD.
static final int	SORTED_SET_SINGLE_VALUED_SORTED	Single-valued sorted set values, encoded as sorted values, so no level of indirection: docId -> ord.
static final int	SORTED_SET_WITH_ADDRESSES	Standard storage for sorted set values with 1 level of indirection: docId -> address -> ord.
static final int	TABLE_COMPRESSED	Compressed by giving IDs to unique values.

Constructor Summary

Constructors

Constructor	Description
Lucene45DocValuesConsumer(SegmentWriteState state, String dataCodec, String dataExtension, String metaCodec, String metaExtension)	expert: Creates a new writer

Method Summary

Modifier and Type	Method	Description
void	addBinaryField(FieldInfo field, Iterable<BytesRef> values)	Writes binary docvalues for a field.
void	addNumericField(FieldInfo field, Iterable<Number> values)	Writes numeric docvalues for a field.
void	addSortedField(FieldInfo field, Iterable<BytesRef> values, Iterable<Number> docToOrd)	Writes pre-sorted binary docvalues for a field.
void	addSortedSetField(FieldInfo field, Iterable<BytesRef> values, Iterable<Number> docToOrdCount, Iterable<Number> ords)	Writes pre-sorted set docvalues for a field
protected void	addTermsDict(FieldInfo field, Iterable<BytesRef> values)	expert: writes a value dictionary for a sorted/sortedset field
void	close()

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

mergeBinaryField, mergeNumericField, mergeSortedField, mergeSortedSetField

Methods inherited from class java.lang.Object

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

Field Details

DELTA_COMPRESSED

public static final int DELTA_COMPRESSED

Compressed using packed blocks of ints.

See Also:

• Constant Field Values

GCD_COMPRESSED

public static final int GCD_COMPRESSED

Compressed by computing the GCD.

See Also:

• Constant Field Values

TABLE_COMPRESSED

public static final int TABLE_COMPRESSED

Compressed by giving IDs to unique values.

See Also:

• Constant Field Values

BINARY_FIXED_UNCOMPRESSED

public static final int BINARY_FIXED_UNCOMPRESSED

Uncompressed binary, written directly (fixed length).

See Also:

• Constant Field Values

BINARY_VARIABLE_UNCOMPRESSED

public static final int BINARY_VARIABLE_UNCOMPRESSED

Uncompressed binary, written directly (variable length).

See Also:

• Constant Field Values

BINARY_PREFIX_COMPRESSED

public static final int BINARY_PREFIX_COMPRESSED

Compressed binary with shared prefixes

See Also:

• Constant Field Values

SORTED_SET_WITH_ADDRESSES

public static final int SORTED_SET_WITH_ADDRESSES

Standard storage for sorted set values with 1 level of indirection: docId -> address -> ord.

See Also:

• Constant Field Values

SORTED_SET_SINGLE_VALUED_SORTED

public static final int SORTED_SET_SINGLE_VALUED_SORTED

Single-valued sorted set values, encoded as sorted values, so no level of indirection: docId -> ord.

See Also:

• Constant Field Values

Constructor Details

Lucene45DocValuesConsumer

public Lucene45DocValuesConsumer(SegmentWriteState state,
 String dataCodec,
 String dataExtension,
 String metaCodec,
 String metaExtension)
                          throws IOException

expert: Creates a new writer

Throws:

IOException

Method Details

addNumericField

public void addNumericField(FieldInfo field,
 Iterable<Number> values)
                     throws IOException

Description copied from class: DocValuesConsumer

Writes numeric docvalues for a field.

Specified by:

addNumericField in class DocValuesConsumer

Parameters:

field - field information

values - Iterable of numeric values (one for each document). null indicates a missing value.

Throws:

IOException - if an I/O error occurred.

addBinaryField

public void addBinaryField(FieldInfo field,
 Iterable<BytesRef> values)
                    throws IOException

Description copied from class: DocValuesConsumer

Writes binary docvalues for a field.

Specified by:

addBinaryField in class DocValuesConsumer

Parameters:

field - field information

values - Iterable of binary values (one for each document). null indicates a missing value.

Throws:

IOException - if an I/O error occurred.

addTermsDict

protected void addTermsDict(FieldInfo field,
 Iterable<BytesRef> values)
                     throws IOException

expert: writes a value dictionary for a sorted/sortedset field

Throws:

IOException

addSortedField

public void addSortedField(FieldInfo field,
 Iterable<BytesRef> values,
 Iterable<Number> docToOrd)
                    throws IOException

Description copied from class: DocValuesConsumer

Writes pre-sorted binary docvalues for a field.

Specified by:

addSortedField in class DocValuesConsumer

Parameters:

field - field information

values - Iterable of binary values in sorted order (deduplicated).

docToOrd - Iterable of ordinals (one for each document). -1 indicates a missing value.

Throws:

IOException - if an I/O error occurred.

addSortedSetField

public void addSortedSetField(FieldInfo field,
 Iterable<BytesRef> values,
 Iterable<Number> docToOrdCount,
 Iterable<Number> ords)
                       throws IOException

Description copied from class: DocValuesConsumer

Writes pre-sorted set docvalues for a field

Specified by:

addSortedSetField in class DocValuesConsumer

Parameters:

field - field information

values - Iterable of binary values in sorted order (deduplicated).

docToOrdCount - Iterable of the number of values for each document. A zero ordinal count indicates a missing value.

ords - Iterable of ordinal occurrences (docToOrdCount*maxDoc total).

Throws:

IOException - if an I/O error occurred.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException