Home » lucene-3.0.1-src » org.apache » lucene » search » [javadoc | source]
org.apache.lucene.search
abstract public static class: Explanation.IDFExplanation [javadoc | source]
java.lang.Object
   org.apache.lucene.search.Explanation$IDFExplanation

All Implemented Interfaces:
    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.
Method from org.apache.lucene.search.Explanation$IDFExplanation Summary:
explain,   getIdf
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.search.Explanation$IDFExplanation Detail:
 abstract public String explain()
    This should be calculated lazily if possible.
 abstract public float getIdf()