Lucene.Net  3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Properties
Classes | Public Member Functions | Properties | List of all members
Lucene.Net.Search.Explanation Class Reference

Expert: Describes the score computation for document and query. More...

Inherited by Lucene.Net.Search.ComplexExplanation.

Classes

class  IDFExplanation
 Small Util class used to pass both an idf factor as well as an explanation for that factor. More...
 

Public Member Functions

 Explanation ()
 
 Explanation (float value, System.String description)
 
virtual Explanation[] GetDetails ()
 The sub-nodes of this explanation node.
 
virtual void AddDetail (Explanation detail)
 Adds a sub-node to this explanation node.
 
override System.String ToString ()
 Render an explanation as text.
 
virtual System.String ToHtml ()
 Render an explanation as HTML.
 

Properties

virtual bool IsMatch [get]
 Indicates whether or not this Explanation models a good match.
 
virtual float Value [get, set]
 The value assigned to this explanation node.
 
virtual string Description [get, set]
 A description of this explanation node.
 

Detailed Description

Expert: Describes the score computation for document and query.

Definition at line 26 of file Explanation.cs.

Constructor & Destructor Documentation

Lucene.Net.Search.Explanation.Explanation ( )

Definition at line 32 of file Explanation.cs.

Lucene.Net.Search.Explanation.Explanation ( float  value,
System.String  description 
)

Definition at line 36 of file Explanation.cs.

Member Function Documentation

virtual void Lucene.Net.Search.Explanation.AddDetail ( Explanation  detail)
virtual

Adds a sub-node to this explanation node.

Definition at line 87 of file Explanation.cs.

virtual Explanation [] Lucene.Net.Search.Explanation.GetDetails ( )
virtual

The sub-nodes of this explanation node.

Definition at line 79 of file Explanation.cs.

virtual System.String Lucene.Net.Search.Explanation.ToHtml ( )
virtual

Render an explanation as HTML.

Definition at line 123 of file Explanation.cs.

override System.String Lucene.Net.Search.Explanation.ToString ( )

Render an explanation as text.

Definition at line 95 of file Explanation.cs.

Property Documentation

virtual string Lucene.Net.Search.Explanation.Description
getset

A description of this explanation node.

Definition at line 65 of file Explanation.cs.

virtual bool Lucene.Net.Search.Explanation.IsMatch
get

Indicates whether or not this Explanation models a good match.

By default, an Explanation represents a "match" if the value is positive.

See Also
Value

Definition at line 51 of file Explanation.cs.

virtual float Lucene.Net.Search.Explanation.Value
getset

The value assigned to this explanation node.

Definition at line 58 of file Explanation.cs.


The documentation for this class was generated from the following file: