org.apache.lucene.queries.function.valuesource

Class JoinDocFreqValueSource

java.lang.Object

org.apache.lucene.queries.function.ValueSource

org.apache.lucene.queries.function.valuesource.FieldCacheSource

org.apache.lucene.queries.function.valuesource.JoinDocFreqValueSource

public class JoinDocFreqValueSource
extends FieldCacheSource

Use a field value and find the Document Frequency within another field.

Since:

solr 4.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME
protected java.lang.String	qfield

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

field

Constructor Summary

Constructors

Constructor and Description
JoinDocFreqValueSource(java.lang.String field, java.lang.String qfield)

Method Summary

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

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

getField

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

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

qfield

protected final java.lang.String qfield

Constructor Detail

JoinDocFreqValueSource

public JoinDocFreqValueSource(java.lang.String field,
                              java.lang.String qfield)

Method Detail

description

public java.lang.String description()

Description copied from class: ValueSource

description of field, used in explain()

Overrides:

description in class FieldCacheSource

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.

Specified by:

getValues in class ValueSource

Throws:

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class FieldCacheSource

hashCode

public int hashCode()

Overrides:

hashCode in class FieldCacheSource