WeightFactorFunction (elasticsearch-extend 3.2 API)

java.lang.Object
- org.elasticsearch.common.lucene.search.function.ScoreFunction
- - org.elasticsearch.common.lucene.search.function.WeightFactorFunction

public class WeightFactorFunction
extends ScoreFunction

Constructor Summary

Constructors
Constructor Description

WeightFactorFunction(float weight)

WeightFactorFunction(float weight, ScoreFunction scoreFunction)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`doEquals(ScoreFunction other)`	Indicates whether some other `ScoreFunction` object of the same type is "equal to" this one.
`protected int`	`doHashCode()`
`Explanation`	`explainWeight()`
`LeafScoreFunction`	`getLeafScoreFunction(LeafReaderContext ctx)`
`ScoreFunction`	`getScoreFunction()`
`float`	`getWeight()`
`boolean`	`needsScores()`	Indicates if document scores are needed by this function.

Methods inherited from class org.elasticsearch.common.lucene.search.function.ScoreFunction
equals, getDefaultScoreCombiner, hashCode, rewrite

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WeightFactorFunction
```
public WeightFactorFunction(float weight,
                            ScoreFunction scoreFunction)
```
  - WeightFactorFunction
```
public WeightFactorFunction(float weight)
```
- Method Detail
  - getLeafScoreFunction
```
public LeafScoreFunction getLeafScoreFunction(LeafReaderContext ctx)
                                       throws IOException
```
    Specified by:
    
    getLeafScoreFunction in class ScoreFunction
    
    Throws:
    
    IOException
  - needsScores
```
public boolean needsScores()
```
    Description copied from class: ScoreFunction
    
    Indicates if document scores are needed by this function.
    
    Specified by:
    
    needsScores in class ScoreFunction
    
    Returns:
    
    true if scores are needed.
  - explainWeight
```
public Explanation explainWeight()
```
  - getWeight
```
public float getWeight()
```
    Overrides:
    
    getWeight in class ScoreFunction
  - getScoreFunction
```
public ScoreFunction getScoreFunction()
```
  - doEquals
```
protected boolean doEquals(ScoreFunction other)
```
    Description copied from class: ScoreFunction
    
    Indicates whether some other ScoreFunction object of the same type is "equal to" this one.
    
    Specified by:
    
    doEquals in class ScoreFunction
  - doHashCode
```
protected int doHashCode()
```
    Specified by:
    
    doHashCode in class ScoreFunction