org.apache.lucene.queries.function.valuesource
Class TotalTermFreqValueSource
java.lang.Object
org.apache.lucene.queries.function.ValueSource
org.apache.lucene.queries.function.valuesource.TotalTermFreqValueSource
public class TotalTermFreqValueSource
- extends ValueSource
TotalTermFreqValueSource
returns the total term freq
(sum of term freqs across all documents).
Returns -1 if frequencies were omitted for the field, or if
the codec doesn't support this statistic.
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
field
protected final String field
indexedField
protected final String indexedField
val
protected final String val
indexedBytes
protected final BytesRef indexedBytes
TotalTermFreqValueSource
public TotalTermFreqValueSource(String field,
String val,
String indexedField,
BytesRef indexedBytes)
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 context,
AtomicReaderContext readerContext)
throws IOException
- Description copied from class:
ValueSource
- Gets the values for this reader and the context that was previously
passed to createWeight()
- Specified by:
getValues
in class ValueSource
- Throws:
IOException
createWeight
public void createWeight(Map context,
IndexSearcher searcher)
throws IOException
- Description copied from class:
ValueSource
- Implementations should propagate createWeight to sub-ValueSources which can optionally store
weight info in the context. The context object will be passed to getValues()
where this info can be retrieved.
- Overrides:
createWeight
in class ValueSource
- Throws:
IOException
hashCode
public int hashCode()
- Specified by:
hashCode
in class ValueSource
equals
public boolean equals(Object o)
- Specified by:
equals
in class ValueSource
Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.