Class SumTotalTermFreqValueSource
java.lang.Object
org.apache.lucene.queries.function.ValueSource
org.apache.lucene.queries.function.valuesource.SumTotalTermFreqValueSource
SumTotalTermFreqValueSource returns the number of tokens. (sum of term freqs across
all documents, across all terms).- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidcreateWeight(Map<Object, Object> context, IndexSearcher searcher) Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.description of field, used in explain()booleangetValues(Map<Object, Object> context, LeafReaderContext readerContext) Gets the values for this reader and the context that was previously passed to createWeight().inthashCode()name()Methods inherited from class org.apache.lucene.queries.function.ValueSource
asDoubleValuesSource, asLongValuesSource, fromDoubleValuesSource, getSortField, newContext, toString
-
Field Details
-
indexedField
-
-
Constructor Details
-
SumTotalTermFreqValueSource
-
-
Method Details
-
name
-
description
Description copied from class:ValueSourcedescription of field, used in explain()- Specified by:
descriptionin classValueSource
-
getValues
public FunctionValues getValues(Map<Object, Object> context, LeafReaderContext readerContext) throws IOExceptionDescription copied from class:ValueSourceGets 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:
getValuesin classValueSource- Throws:
IOException
-
createWeight
Description copied from class:ValueSourceImplementations 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:
createWeightin classValueSource- Throws:
IOException
-
hashCode
public int hashCode()- Specified by:
hashCodein classValueSource
-
equals
- Specified by:
equalsin classValueSource
-