Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class ComplexExplanation

    Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value.

    Inheritance
    object
    Explanation
    ComplexExplanation
    Inherited Members
    Explanation.Value
    Explanation.Description
    Explanation.GetDetails()
    Explanation.AddDetail(Explanation)
    Explanation.ToString()
    Explanation.ToString(int)
    Explanation.ToHtml()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search
    Assembly: Lucene.Net.dll
    Syntax
    public class ComplexExplanation : Explanation

    Constructors

    ComplexExplanation()

    Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value.

    Declaration
    public ComplexExplanation()

    ComplexExplanation(bool, float, string)

    Expert: Describes the score computation for document and query, and can distinguish a match independent of a positive value.

    Declaration
    public ComplexExplanation(bool match, float value, string description)
    Parameters
    Type Name Description
    bool match
    float value
    string description

    Properties

    IsMatch

    Indicates whether or not this Explanation models a good match.

    If the match status is explicitly set (i.e.: not null) this method uses it; otherwise it defers to the superclass.

    Declaration
    public override bool IsMatch { get; }
    Property Value
    Type Description
    bool
    Overrides
    Explanation.IsMatch
    See Also
    Match

    Match

    Gets or Sets the match status assigned to this explanation node. May be null if match status is unknown.

    Declaration
    public virtual bool? Match { get; set; }
    Property Value
    Type Description
    bool?

    Methods

    GetSummary()

    A short one line summary which should contain all high level information about this Explanation, without the "Details"

    Declaration
    protected override string GetSummary()
    Returns
    Type Description
    string
    Overrides
    Explanation.GetSummary()
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.