public abstract class ValueSource
extends java.lang.Object
implements java.io.Serializable
At its default/simplest form, values - one per doc - are used as the score of that doc.
Values are instantiated as
DocValues
for a particular reader.
ValueSource implementations differ in RAM requirements: it would always be a factor of the number of documents, but for each document the number of bytes can be 1, 2, 4, or 8.
Constructor and Description |
---|
ValueSource() |
Modifier and Type | Method and Description |
---|---|
abstract java.lang.String |
description()
description of field, used in explain()
|
abstract boolean |
equals(java.lang.Object o)
Needed for possible caching of query results - used by
ValueSourceQuery.equals(Object) . |
abstract DocValues |
getValues(IndexReader reader)
Return the DocValues used by the function query.
|
abstract int |
hashCode()
Needed for possible caching of query results - used by
ValueSourceQuery.hashCode() . |
java.lang.String |
toString() |
public abstract DocValues getValues(IndexReader reader) throws java.io.IOException
reader
- the IndexReader used to read these values.
If any caching is involved, that caching would also be IndexReader based.java.io.IOException
- for any error.public abstract java.lang.String description()
public java.lang.String toString()
toString
in class java.lang.Object
public abstract boolean equals(java.lang.Object o)
ValueSourceQuery.equals(Object)
.equals
in class java.lang.Object
Object.equals(Object)
public abstract int hashCode()
ValueSourceQuery.hashCode()
.hashCode
in class java.lang.Object
Object.hashCode()