| java.lang.Object | |
| ↳ | org.apache.lucene.search.function.ValueSource |
 Known Direct Subclasses
|
|
Known Indirect Subclasses
|
Class Overview
Expert: source of values for basic function queries.
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.
WARNING: The status of the search.function package is experimental. The APIs introduced here might change in the future and will not be supported anymore in such a case.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
description of field, used in explain()
| |||||||||||
Needed for possible caching of query results - used by
equals(Object). | |||||||||||
Return the DocValues used by the function query.
| |||||||||||
Needed for possible caching of query results - used by
hashCode(). | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Public Constructors
public ValueSource ()
Public Methods
public abstract boolean equals (Object o)
Needed for possible caching of query results - used by equals(Object).
See Also
public abstract DocValues getValues (IndexReader reader)
Return the DocValues used by the function query.
Parameters
| reader | the IndexReader used to read these values. If any caching is involved, that caching would also be IndexReader based. |
|---|
Throws
| IOException | for any error. |
|---|
public abstract int hashCode ()
Needed for possible caching of query results - used by hashCode().