Explanation.IDFExplanation (Lucene 3.6.2 API)

Skip navigation links

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.lucene.search.Explanation.IDFExplanation

All Implemented Interfaces:

Serializable

Enclosing class:

Explanation
```
public abstract static class Explanation.IDFExplanation
extends Object
implements Serializable
```
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.

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  IDFExplanation()
- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  abstract String explain()
  This should be calculated lazily if possible.
  
  abstract float getIdf()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IDFExplanation
```
public IDFExplanation()
```
- Method Detail
  - getIdf
```
public abstract float getIdf()
```
    Returns:
    
    the idf factor
  - explain
```
public abstract String explain()
```
    This should be calculated lazily if possible.
    
    Returns:
    
    the explanation for the idf factor.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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