Method Explain
Explain(Query, Int32)
Returns an Explanation that describes how doc scored against
query.
This is intended to be used in developing Similarity implementations, and, for good performance, should not be displayed with every hit. Computing an explanation is as expensive as executing the query over the entire index.
Declaration
[TargetMethod("Explain", 1)]
public virtual Explanation Explain(Query query, int doc)Parameters
| Type | Name | Description |
|---|---|---|
| Query | query | |
| System.Int32 | doc |
Returns
| Type | Description |
|---|---|
| Explanation |
Explain(Weight, Int32)
Expert: low-level implementation method
Returns an Explanation that describes how doc scored against
weight.
This is intended to be used in developing Similarity implementations, and, for good performance, should not be displayed with every hit. Computing an explanation is as expensive as executing the query over the entire index.
Applications should call Explain(Query, Int32).
Declaration
[TargetMethod("Explain", 2)]
protected virtual Explanation Explain(Weight weight, int doc)Parameters
| Type | Name | Description |
|---|---|---|
| Weight | weight | |
| System.Int32 | doc |
Returns
| Type | Description |
|---|---|
| Explanation |
Exceptions
| Type | Condition |
|---|---|
| BooleanQuery.TooManyClausesException | If a query would exceed MaxClauseCount clauses. |
