Class DocFreqValueSource
java.lang.Object
org.apache.lucene.queries.function.ValueSource
org.apache.lucene.queries.function.valuesource.DocFreqValueSource
- Direct Known Subclasses:
IDFValueSource
,TermFreqValueSource
DocFreqValueSource
returns the number of documents containing the term.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Field Summary
-
Constructor Summary
ConstructorDescriptionDocFreqValueSource
(String field, String val, String indexedField, BytesRef indexedBytes) -
Method Summary
Modifier and TypeMethodDescriptionvoid
createWeight
(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()boolean
getValues
(Map<Object, Object> context, LeafReaderContext readerContext) Gets the values for this reader and the context that was previously passed to createWeight().int
hashCode()
name()
Methods inherited from class org.apache.lucene.queries.function.ValueSource
asDoubleValuesSource, asLongValuesSource, fromDoubleValuesSource, getSortField, newContext, toString
-
Field Details
-
field
-
indexedField
-
val
-
indexedBytes
-
-
Constructor Details
-
DocFreqValueSource
-
-
Method Details
-
name
-
description
Description copied from class:ValueSource
description of field, used in explain()- Specified by:
description
in classValueSource
-
getValues
public FunctionValues getValues(Map<Object, Object> context, LeafReaderContext readerContext) throws IOExceptionDescription 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 classValueSource
- Throws:
IOException
-
createWeight
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 classValueSource
- Throws:
IOException
-
hashCode
public int hashCode()- Specified by:
hashCode
in classValueSource
-
equals
- Specified by:
equals
in classValueSource
-