Module org.apache.lucene.core
Package org.apache.lucene.search
Class DoubleValuesSource.FieldValuesSource
java.lang.Object
org.apache.lucene.search.DoubleValuesSource
org.apache.lucene.search.DoubleValuesSource.FieldValuesSource
- All Implemented Interfaces:
SegmentCacheable
- Enclosing class:
DoubleValuesSource
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) final LongToDoubleFunction
(package private) final String
Fields inherited from class org.apache.lucene.search.DoubleValuesSource
SCORES
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
FieldValuesSource
(String field, LongToDoubleFunction decoder) -
Method Summary
Modifier and TypeMethodDescriptionboolean
explain
(LeafReaderContext ctx, int docId, Explanation scoreExplanation) An explanation of the value for the named document.getValues
(LeafReaderContext ctx, DoubleValues scores) Returns aDoubleValues
instance for the passed-in LeafReaderContext and scoresint
hashCode()
boolean
boolean
Return true if document scores are needed to calculate valuesrewrite
(IndexSearcher searcher) Return a DoubleValuesSource specialised for the given IndexSearchertoString()
Methods inherited from class org.apache.lucene.search.DoubleValuesSource
constant, fromDoubleField, fromField, fromFloatField, fromIntField, fromLongField, fromQuery, fromScorer, getSortField, similarityToQueryVector, similarityToQueryVector, toLongValuesSource, toSortableLongDoubleValuesSource
-
Field Details
-
field
-
decoder
-
-
Constructor Details
-
FieldValuesSource
-
-
Method Details
-
equals
- Specified by:
equals
in classDoubleValuesSource
-
toString
- Specified by:
toString
in classDoubleValuesSource
-
hashCode
public int hashCode()- Specified by:
hashCode
in classDoubleValuesSource
-
getValues
Description copied from class:DoubleValuesSource
Returns aDoubleValues
instance for the passed-in LeafReaderContext and scoresIf scores are not needed to calculate the values (ie
returns false
, callers may safely passnull
for thescores
parameter.- Specified by:
getValues
in classDoubleValuesSource
- Throws:
IOException
-
needsScores
public boolean needsScores()Description copied from class:DoubleValuesSource
Return true if document scores are needed to calculate values- Specified by:
needsScores
in classDoubleValuesSource
-
isCacheable
- Returns:
true
if the object can be cached against a given leaf
-
explain
public Explanation explain(LeafReaderContext ctx, int docId, Explanation scoreExplanation) throws IOException Description copied from class:DoubleValuesSource
An explanation of the value for the named document.- Overrides:
explain
in classDoubleValuesSource
- Parameters:
ctx
- the readers context to create theExplanation
for.docId
- the document's id relative to the given context's reader- Returns:
- an Explanation for the value
- Throws:
IOException
- if anIOException
occurs
-
rewrite
Description copied from class:DoubleValuesSource
Return a DoubleValuesSource specialised for the given IndexSearcherImplementations should assume that this will only be called once. IndexReader-independent implementations can just return
this
Queries that use DoubleValuesSource objects should call rewrite() during
Query.createWeight(IndexSearcher, ScoreMode, float)
rather than duringQuery.rewrite(IndexSearcher)
to avoid IndexReader reference leakage.For the same reason, implementations that cache references to the IndexSearcher should return a new object from this method.
- Specified by:
rewrite
in classDoubleValuesSource
- Throws:
IOException
-