Class DocFreqValueSource
- java.lang.Object
-
- org.apache.lucene.queries.function.ValueSource
-
- org.apache.lucene.queries.function.valuesource.DocFreqValueSource
-
- Direct Known Subclasses:
IDFValueSource
,TermFreqValueSource
public class DocFreqValueSource extends ValueSource
DocFreqValueSource
returns the number of documents containing the term.
-
-
Constructor Summary
Constructors Constructor Description DocFreqValueSource(java.lang.String field, java.lang.String val, java.lang.String indexedField, BytesRef indexedBytes)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
createWeight(java.util.Map context, IndexSearcher searcher)
Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.java.lang.String
description()
description of field, used in explain()boolean
equals(java.lang.Object o)
FunctionValues
getValues(java.util.Map context, AtomicReaderContext readerContext)
Gets the values for this reader and the context that was previously passed to createWeight()int
hashCode()
java.lang.String
name()
-
Methods inherited from class org.apache.lucene.queries.function.ValueSource
getSortField, newContext, toString
-
-
-
-
Constructor Detail
-
DocFreqValueSource
public DocFreqValueSource(java.lang.String field, java.lang.String val, java.lang.String indexedField, BytesRef indexedBytes)
-
-
Method Detail
-
name
public java.lang.String name()
-
description
public java.lang.String description()
Description copied from class:ValueSource
description of field, used in explain()- Specified by:
description
in classValueSource
-
getValues
public FunctionValues getValues(java.util.Map context, AtomicReaderContext 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()- Specified by:
getValues
in classValueSource
- Throws:
java.io.IOException
-
createWeight
public void createWeight(java.util.Map context, IndexSearcher searcher) throws java.io.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 classValueSource
- Throws:
java.io.IOException
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classValueSource
-
equals
public boolean equals(java.lang.Object o)
- Specified by:
equals
in classValueSource
-
-