| java.lang.Object | |
| ↳ | org.apache.lucene.search.Explanation.IDFExplanation |
Class Overview
Small Util class used to pass both an idf factor as well as an
explanation for that factor.
This class will likely be held on a Weight, so be aware
before storing any large or un-serializable fields.
Summary
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This should be calculated lazily if possible.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Constructors
public Explanation.IDFExplanation ()
Public Methods
public abstract String explain ()
This should be calculated lazily if possible.
Returns
- the explanation for the idf factor.
public abstract float getIdf ()
Returns
- the idf factor