org.apache.lucene.search

Class Explanation.IDFExplanation

java.lang.Object

org.apache.lucene.search.Explanation.IDFExplanation

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

Explanation

public abstract static class Explanation.IDFExplanation
extends java.lang.Object
implements java.io.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 and Description
IDFExplanation()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.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 java.lang.String explain()

This should be calculated lazily if possible.

Returns:

the explanation for the idf factor.