Package org.apache.lucene.index

Class SegmentDocValuesProducer

java.lang.Object

org.apache.lucene.codecs.DocValuesProducer

org.apache.lucene.index.SegmentDocValuesProducer

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable

class SegmentDocValuesProducer
extends DocValuesProducer

Encapsulates multiple producers when there are docvalues updates as one producer

Field Summary

Fields

Modifier and Type	Field	Description
private static final long	BASE_RAM_BYTES_USED
(package private) final List<Long>	dvGens
(package private) final Set<DocValuesProducer>	dvProducers
(package private) final Map<String,DocValuesProducer>	dvProducersByField
private static final long	LONG_RAM_BYTES_USED

Fields inherited from interface org.apache.lucene.util.Accountable

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Constructor	Description
SegmentDocValuesProducer(SegmentCommitInfo si, Directory dir, FieldInfos coreInfos, FieldInfos allInfos, SegmentDocValues segDocValues)	Creates a new producer that handles updated docvalues fields

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this producer
void	close()
BinaryDocValues	getBinary(FieldInfo field)	Returns BinaryDocValues for this field.
Collection<Accountable>	getChildResources()	Returns nested resources of this class.
NumericDocValues	getNumeric(FieldInfo field)	Returns NumericDocValues for this field.
SortedDocValues	getSorted(FieldInfo field)	Returns SortedDocValues for this field.
SortedNumericDocValues	getSortedNumeric(FieldInfo field)	Returns SortedNumericDocValues for this field.
SortedSetDocValues	getSortedSet(FieldInfo field)	Returns SortedSetDocValues for this field.
long	ramBytesUsed()	Return the memory usage of this object in bytes.
String	toString()

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

getMergeInstance

Methods inherited from class java.lang.Object

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

Field Details

LONG_RAM_BYTES_USED

private static final long LONG_RAM_BYTES_USED

BASE_RAM_BYTES_USED

private static final long BASE_RAM_BYTES_USED

dvProducersByField

final Map<String,DocValuesProducer> dvProducersByField

dvProducers

final Set<DocValuesProducer> dvProducers

dvGens

final List<Long> dvGens

Constructor Details

SegmentDocValuesProducer

SegmentDocValuesProducer(SegmentCommitInfo si,
 Directory dir,
 FieldInfos coreInfos,
 FieldInfos allInfos,
 SegmentDocValues segDocValues)
                  throws IOException

Creates a new producer that handles updated docvalues fields

Parameters:

si - commit point

dir - directory

coreInfos - fieldinfos for the segment

allInfos - all fieldinfos including updated ones

segDocValues - producer map

Throws:

IOException

Method Details

getNumeric

public NumericDocValues getNumeric(FieldInfo field)
                            throws IOException

Description copied from class: DocValuesProducer

Returns NumericDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:

getNumeric in class DocValuesProducer

Throws:

IOException

getBinary

public BinaryDocValues getBinary(FieldInfo field)
                          throws IOException

Description copied from class: DocValuesProducer

Returns BinaryDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:

getBinary in class DocValuesProducer

Throws:

IOException

getSorted

public SortedDocValues getSorted(FieldInfo field)
                          throws IOException

Description copied from class: DocValuesProducer

Returns SortedDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:

getSorted in class DocValuesProducer

Throws:

IOException

getSortedNumeric

public SortedNumericDocValues getSortedNumeric(FieldInfo field)
                                        throws IOException

Description copied from class: DocValuesProducer

Returns SortedNumericDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:

getSortedNumeric in class DocValuesProducer

Throws:

IOException

getSortedSet

public SortedSetDocValues getSortedSet(FieldInfo field)
                                throws IOException

Description copied from class: DocValuesProducer

Returns SortedSetDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread.

Specified by:

getSortedSet in class DocValuesProducer

Throws:

IOException

checkIntegrity

public void checkIntegrity()
                    throws IOException

Description copied from class: DocValuesProducer

Checks consistency of this producer

Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

Specified by:

checkIntegrity in class DocValuesProducer

Throws:

IOException

close

public void close()
           throws IOException

Throws:

IOException

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

Return the memory usage of this object in bytes. Negative values are illegal.

getChildResources

public Collection<Accountable> getChildResources()

Description copied from interface: Accountable

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

See Also:

• Accountables

toString

public String toString()

Overrides:

toString in class Object