org.apache.lucene.queries.function.valuesource
Class LinearFloatFunction

java.lang.Object
  extended by org.apache.lucene.queries.function.ValueSource
      extended by org.apache.lucene.queries.function.valuesource.LinearFloatFunction

public class LinearFloatFunction
extends ValueSource

LinearFloatFunction implements a linear function over another ValueSource.
Normally Used as an argument to a FunctionQuery


Field Summary
protected  float intercept
           
protected  float slope
           
protected  ValueSource source
           
 
Constructor Summary
LinearFloatFunction(ValueSource source, float slope, float intercept)
           
 
Method Summary
 void createWeight(Map context, IndexSearcher searcher)
          Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context.
 String description()
          description of field, used in explain()
 boolean equals(Object o)
           
 FunctionValues getValues(Map context, AtomicReaderContext readerContext)
          Gets the values for this reader and the context that was previously passed to createWeight()
 int hashCode()
           
 
Methods inherited from class org.apache.lucene.queries.function.ValueSource
getSortField, newContext, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

source

protected final ValueSource source

slope

protected final float slope

intercept

protected final float intercept
Constructor Detail

LinearFloatFunction

public LinearFloatFunction(ValueSource source,
                           float slope,
                           float intercept)
Method Detail

description

public String description()
Description copied from class: ValueSource
description of field, used in explain()

Specified by:
description in class ValueSource

getValues

public FunctionValues getValues(Map context,
                                AtomicReaderContext readerContext)
                         throws IOException
Description copied from class: ValueSource
Gets the values for this reader and the context that was previously passed to createWeight()

Specified by:
getValues in class ValueSource
Throws:
IOException

createWeight

public void createWeight(Map context,
                         IndexSearcher searcher)
                  throws IOException
Description copied from class: ValueSource
Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to getValues() where this info can be retrieved.

Overrides:
createWeight in class ValueSource
Throws:
IOException

hashCode

public int hashCode()
Specified by:
hashCode in class ValueSource

equals

public boolean equals(Object o)
Specified by:
equals in class ValueSource


Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.