Package org.apache.lucene.document
Class FeatureDoubleValuesSource
- java.lang.Object
-
- org.apache.lucene.search.DoubleValuesSource
-
- org.apache.lucene.document.FeatureDoubleValuesSource
-
- All Implemented Interfaces:
SegmentCacheable
class FeatureDoubleValuesSource extends DoubleValuesSource
ADoubleValuesSource
instance which can be used to read the values of a feature from aFeatureField
for documents.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description (package private) static class
FeatureDoubleValuesSource.FeatureDoubleValues
-
Field Summary
Fields Modifier and Type Field Description private BytesRef
featureName
private java.lang.String
field
-
Fields inherited from class org.apache.lucene.search.DoubleValuesSource
SCORES
-
-
Constructor Summary
Constructors Constructor Description FeatureDoubleValuesSource(java.lang.String field, java.lang.String featureName)
Creates aDoubleValuesSource
instance which can be used to read the values of a feature from the aFeatureField
for documents.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
DoubleValues
getValues(LeafReaderContext ctx, DoubleValues scores)
Returns aDoubleValues
instance for the passed-in LeafReaderContext and scoresint
hashCode()
boolean
isCacheable(LeafReaderContext ctx)
boolean
needsScores()
Return true if document scores are needed to calculate valuesDoubleValuesSource
rewrite(IndexSearcher reader)
Return a DoubleValuesSource specialised for the given IndexSearcherjava.lang.String
toString()
-
Methods inherited from class org.apache.lucene.search.DoubleValuesSource
constant, explain, fromDoubleField, fromField, fromFloatField, fromIntField, fromLongField, fromQuery, fromScorer, getSortField, toLongValuesSource
-
-
-
-
Field Detail
-
featureName
private final BytesRef featureName
-
field
private final java.lang.String field
-
-
Constructor Detail
-
FeatureDoubleValuesSource
public FeatureDoubleValuesSource(java.lang.String field, java.lang.String featureName)
Creates aDoubleValuesSource
instance which can be used to read the values of a feature from the aFeatureField
for documents.- Parameters:
field
- field name. Must not be null.featureName
- feature name. Must not be null.- Throws:
java.lang.NullPointerException
- iffield
orfeatureName
is null.
-
-
Method Detail
-
isCacheable
public boolean isCacheable(LeafReaderContext ctx)
- Returns:
true
if the object can be cached against a given leaf
-
getValues
public DoubleValues getValues(LeafReaderContext ctx, DoubleValues scores) throws java.io.IOException
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:
java.io.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
-
rewrite
public DoubleValuesSource rewrite(IndexSearcher reader) throws java.io.IOException
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(IndexReader)
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:
java.io.IOException
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classDoubleValuesSource
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in classDoubleValuesSource
-
toString
public java.lang.String toString()
- Specified by:
toString
in classDoubleValuesSource
-
-