org.apache.solr.search.function

Class FunctionQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.solr.search.function.FunctionQuery

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class FunctionQuery
extends org.apache.lucene.search.Query

Returns a score for each document based on a ValueSource, often some function of the value of a field. Note: This API is experimental and may change in non backward-compatible ways in the future

Version:

$Id: FunctionQuery.java 1297074 2012-03-05 14:40:17Z uschindler $

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	FunctionQuery.AllScorer
protected class	FunctionQuery.FunctionWeight

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ValueSource	func

Constructor Summary

Constructors

Constructor and Description
FunctionQuery(ValueSource func)

Method Summary

Modifier and Type	Method and Description
org.apache.lucene.search.Weight	createWeight(org.apache.lucene.search.Searcher searcher)
boolean	equals(java.lang.Object o) Returns true if o is equal to this.
void	extractTerms(java.util.Set terms)
ValueSource	getValueSource()
int	hashCode() Returns a hash code value for this object.
org.apache.lucene.search.Query	rewrite(org.apache.lucene.index.IndexReader reader)
java.lang.String	toString(java.lang.String field) Prints a user-readable version of this query.

Methods inherited from class org.apache.lucene.search.Query

clone, combine, getBoost, getSimilarity, mergeBooleanQueries, setBoost, toString, weight

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

func

ValueSource func

Constructor Detail

FunctionQuery

public FunctionQuery(ValueSource func)

Parameters:

func - defines the function to be used for scoring

Method Detail

getValueSource

public ValueSource getValueSource()

Returns:

The associated ValueSource

rewrite

public org.apache.lucene.search.Query rewrite(org.apache.lucene.index.IndexReader reader)
                                       throws java.io.IOException

Overrides:

rewrite in class org.apache.lucene.search.Query

Throws:

java.io.IOException

extractTerms

public void extractTerms(java.util.Set terms)

Overrides:

extractTerms in class org.apache.lucene.search.Query

createWeight

public org.apache.lucene.search.Weight createWeight(org.apache.lucene.search.Searcher searcher)
                                             throws java.io.IOException

Overrides:

createWeight in class org.apache.lucene.search.Query

Throws:

java.io.IOException

toString

public java.lang.String toString(java.lang.String field)

Prints a user-readable version of this query.

Specified by:

toString in class org.apache.lucene.search.Query

equals

public boolean equals(java.lang.Object o)

Returns true if o is equal to this.

Overrides:

equals in class org.apache.lucene.search.Query

hashCode

public int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class org.apache.lucene.search.Query