org.apache.lucene.queries.function.valuesource

Class IDFValueSource

java.lang.Object

org.apache.lucene.queries.function.ValueSource

org.apache.lucene.queries.function.valuesource.DocFreqValueSource

org.apache.lucene.queries.function.valuesource.IDFValueSource

public class IDFValueSource
extends DocFreqValueSource

Function that returns #idf(long, long) for every document.

Note that the configured Similarity for the field must be a subclass of TFIDFSimilarity

Field Summary

Fields inherited from class org.apache.lucene.queries.function.valuesource.DocFreqValueSource

field, indexedBytes, indexedField, val

Constructor Summary

Constructors

Constructor and Description
IDFValueSource(java.lang.String field, java.lang.String val, java.lang.String indexedField, BytesRef indexedBytes)

Method Summary

Modifier and Type	Method and Description
(package private) static TFIDFSimilarity	asTFIDF(Similarity sim, java.lang.String field)
FunctionValues	getValues(java.util.Map context, LeafReaderContext readerContext) Gets the values for this reader and the context that was previously passed to createWeight().
java.lang.String	name()

Methods inherited from class org.apache.lucene.queries.function.valuesource.DocFreqValueSource

createWeight, description, equals, hashCode

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

asDoubleValuesSource, asLongValuesSource, fromDoubleValuesSource, getSortField, newContext, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IDFValueSource

public IDFValueSource(java.lang.String field,
                      java.lang.String val,
                      java.lang.String indexedField,
                      BytesRef indexedBytes)

Method Detail

name

public java.lang.String name()

Overrides:

name in class DocFreqValueSource

getValues

public FunctionValues getValues(java.util.Map context,
                                LeafReaderContext readerContext)
                         throws java.io.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.

Overrides:

getValues in class DocFreqValueSource

Throws:

java.io.IOException

asTFIDF

static TFIDFSimilarity asTFIDF(Similarity sim,
                               java.lang.String field)