public abstract class LongValuesSource extends Object implements SegmentCacheable
LongValues
To obtain a LongValues
object for a leaf reader, clients should
call rewrite(IndexSearcher)
against the top-level searcher, and
then getValues(LeafReaderContext, DoubleValues)
.
LongValuesSource objects for long and int-valued NumericDocValues fields can
be obtained by calling fromLongField(String)
and fromIntField(String)
.
To obtain a LongValuesSource from a float or double-valued NumericDocValues field,
use DoubleValuesSource.fromFloatField(String)
or DoubleValuesSource.fromDoubleField(String)
and then call DoubleValuesSource.toLongValuesSource()
.Constructor and Description |
---|
LongValuesSource() |
Modifier and Type | Method and Description |
---|---|
static LongValuesSource |
constant(long value)
Creates a LongValuesSource that always returns a constant value
|
abstract boolean |
equals(Object obj) |
static LongValuesSource |
fromIntField(String field)
Creates a LongValuesSource that wraps an int-valued field
|
static LongValuesSource |
fromLongField(String field)
Creates a LongValuesSource that wraps a long-valued field
|
SortField |
getSortField(boolean reverse)
Create a sort field based on the value of this producer
|
abstract LongValues |
getValues(LeafReaderContext ctx,
DoubleValues scores)
Returns a
LongValues instance for the passed-in LeafReaderContext and scores
If scores are not needed to calculate the values (ie returns false , callers
may safely pass null for the scores parameter. |
abstract int |
hashCode() |
abstract boolean |
needsScores()
Return true if document scores are needed to calculate values
|
abstract LongValuesSource |
rewrite(IndexSearcher searcher)
Return a LongValuesSource specialised for the given IndexSearcher
Implementations should assume that this will only be called once.
|
DoubleValuesSource |
toDoubleValuesSource()
Convert to a DoubleValuesSource by casting long values to doubles
|
abstract String |
toString() |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isCacheable
public abstract LongValues getValues(LeafReaderContext ctx, DoubleValues scores) throws IOException
LongValues
instance for the passed-in LeafReaderContext and scores
If scores are not needed to calculate the values (ie returns false
, callers
may safely pass null
for the scores
parameter.IOException
public abstract boolean needsScores()
public abstract LongValuesSource rewrite(IndexSearcher searcher) throws IOException
this
IOException
public SortField getSortField(boolean reverse)
reverse
- true if the sort should be decreasingpublic DoubleValuesSource toDoubleValuesSource()
public static LongValuesSource fromLongField(String field)
public static LongValuesSource fromIntField(String field)
public static LongValuesSource constant(long value)
Copyright © 2000-2024 Apache Software Foundation. All Rights Reserved.