Package org.apache.lucene.queries.function.valuesource

A variety of functions to use with FunctionQuery.

See: Description

Class Summary

Class	Description
BoolFunction
ByteFieldSource	Obtains int field values from the FieldCache using getInts() and makes those values available as other numeric types, casting as needed.
BytesRefFieldSource	An implementation for retrieving FunctionValues instances for string based fields.
ConstNumberSource	ConstNumberSource is the base class for all constant numbers
ConstValueSource	ConstValueSource returns a constant for all documents
DefFunction
DivFloatFunction	Function to divide "a" by "b"
DocFreqValueSource	DocFreqValueSource returns the number of documents containing the term.
DoubleConstValueSource
DoubleFieldSource	Obtains float field values from the FieldCache using getFloats() and makes those values available as other numeric types, casting as needed.
DualFloatFunction
FieldCacheSource	A base class for ValueSource implementations that retrieve values for a single field from the FieldCache.
FloatFieldSource	Obtains float field values from the FieldCache using getFloats() and makes those values available as other numeric types, casting as needed.
IDFValueSource
IfFunction
IntFieldSource	Obtains int field values from the FieldCache using getInts() and makes those values available as other numeric types, casting as needed.
JoinDocFreqValueSource	Use a field value and find the Document Frequency within another field.
LinearFloatFunction	LinearFloatFunction implements a linear function over another ValueSource.
LiteralValueSource	Pass a the field value through as a String, no matter the type // Q: doesn't this mean it's a "string"?
LongFieldSource	Obtains float field values from the FieldCache using getFloats() and makes those values available as other numeric types, casting as needed.
MaxDocValueSource
MaxFloatFunction	MaxFloatFunction returns the max of it's components.
MinFloatFunction	MinFloatFunction returns the min of it's components.
MultiBoolFunction
MultiFloatFunction
MultiFunction
MultiValueSource	A ValueSource that abstractly represents ValueSources for poly fields, and other things.
NormValueSource
NumDocsValueSource
NumericIndexDocValueSource	Expert: obtains numeric field values from a FunctionValues field.
OrdFieldSource	Obtains the ordinal of the field value from the default Lucene FieldCache using getStringIndex().
PowFloatFunction	Function to raise the base "a" to the power "b"
ProductFloatFunction	ProductFloatFunction returns the product of it's components.
QueryValueSource	QueryValueSource returns the relevance score of the query
RangeMapFloatFunction	LinearFloatFunction implements a linear function over another ValueSource.
ReciprocalFloatFunction	ReciprocalFloatFunction implements a reciprocal function f(x) = a/(mx+b), based on the float value of a field or function as exported by ValueSource.
ReverseOrdFieldSource	Obtains the ordinal of the field value from the default Lucene FieldCache using getTermsIndex() and reverses the order.
ScaleFloatFunction	Scales values to be between min and max.
ShortFieldSource
SimpleBoolFunction
SimpleFloatFunction	A simple float function with a single argument
SingleFunction	A function with a single argument
SumFloatFunction	SumFloatFunction returns the sum of it's components.
SumTotalTermFreqValueSource	TotalTermFreqValueSource returns the total term freq (sum of term freqs across all docuyments).
TermFreqValueSource
TFValueSource
TotalTermFreqValueSource	TotalTermFreqValueSource returns the total term freq (sum of term freqs across all docuyments).
VectorValueSource	Converts individual ValueSource instances to leverage the FunctionValues *Val functions that work with multiple values, i.e.

Package org.apache.lucene.queries.function.valuesource Description

A variety of functions to use with FunctionQuery.