Package org.apache.lucene.index

Class EmptyDocValuesProducer

java.lang.Object

org.apache.lucene.codecs.DocValuesProducer

org.apache.lucene.index.EmptyDocValuesProducer

All Implemented Interfaces:

Closeable, AutoCloseable, Accountable

public abstract class EmptyDocValuesProducer
extends DocValuesProducer

Abstract base class implementing a DocValuesProducer that has no doc values.

Field Summary

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

NULL_ACCOUNTABLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EmptyDocValuesProducer()	Sole constructor

Method Summary

Modifier and Type	Method	Description
void	checkIntegrity()	Checks consistency of this producer
void	close()	Closes this doc values producer.
BinaryDocValues	getBinary(FieldInfo field)	Returns BinaryDocValues for this field.
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.

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

getMergeInstance

Methods inherited from class java.lang.Object

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

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

getChildResources

Constructor Details

EmptyDocValuesProducer

protected EmptyDocValuesProducer()

Sole constructor

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()

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

close

public void close()

Closes this doc values producer.

ramBytesUsed

public long ramBytesUsed()

Description copied from interface: Accountable

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