Home » lucene-3.0.1-src » org.apache » lucene » search » function » [javadoc | source]
abstract public class: ValueSource [javadoc | source]

All Implemented Interfaces:

Direct Known Subclasses:
    FloatFieldSource, ShortFieldSource, IntFieldSource, FieldCacheSource, ByteFieldSource, OrdFieldSource, ReverseOrdFieldSource

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.
Method from org.apache.lucene.search.function.ValueSource Summary:
description,   equals,   getValues,   hashCode,   toString
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.search.function.ValueSource Detail:
 abstract public String description()
    description of field, used in explain()
 abstract public boolean equals(Object o)
 abstract public DocValues getValues(IndexReader reader) throws IOException
    Return the DocValues used by the function query.
 abstract public int hashCode()
 public String toString()