Package org.apache.lucene.queries.function.valuesource

Class NumDocsValueSource

java.lang.Object

org.apache.lucene.queries.function.ValueSource

org.apache.lucene.queries.function.valuesource.NumDocsValueSource

public class NumDocsValueSource
extends ValueSource

Returns the value of IndexReader.numDocs() for every document. This is the number of documents excluding deletions.

Constructor Summary

Constructors

Constructor	Description
NumDocsValueSource()

Method Summary

Modifier and Type	Method	Description
String	description()	description of field, used in explain()
boolean	equals(Object o)
FunctionValues	getValues(Map<Object,Object> context, LeafReaderContext readerContext)	Gets the values for this reader and the context that was previously passed to createWeight().
int	hashCode()
String	name()

Methods inherited from class org.apache.lucene.queries.function.ValueSource

asDoubleValuesSource, asLongValuesSource, createWeight, fromDoubleValuesSource, getSortField, newContext, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

NumDocsValueSource

public NumDocsValueSource()

Method Details

name

public String name()

description

public String description()

Description copied from class: ValueSource

description of field, used in explain()

Specified by:

description in class ValueSource

getValues

public FunctionValues getValues(Map<Object,Object> context,
 LeafReaderContext readerContext)
                         throws IOException

Description copied from class: ValueSource

Gets the values for this reader and the context that was previously passed to createWeight(). The values must be consumed in a forward docID manner, and you must call this method again to iterate through the values again.

Specified by:

getValues in class ValueSource

Throws:

IOException

equals

public boolean equals(Object o)

Specified by:

equals in class ValueSource

hashCode

public int hashCode()

Specified by:

hashCode in class ValueSource