Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class FieldTermStack.TermInfo

    Single term with its position/offsets in the document and IDF weight. It is IComparable<T> but considers only position.

    Inheritance
    object
    FieldTermStack.TermInfo
    Implements
    IComparable<FieldTermStack.TermInfo>
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search.VectorHighlight
    Assembly: Lucene.Net.Highlighter.dll
    Syntax
    public class FieldTermStack.TermInfo : IComparable<FieldTermStack.TermInfo>

    Constructors

    TermInfo(string, int, int, int, float)

    Single term with its position/offsets in the document and IDF weight. It is IComparable<T> but considers only position.

    Declaration
    public TermInfo(string text, int startOffset, int endOffset, int position, float weight)
    Parameters
    Type Name Description
    string text
    int startOffset
    int endOffset
    int position
    float weight

    Properties

    EndOffset

    Single term with its position/offsets in the document and IDF weight. It is IComparable<T> but considers only position.

    Declaration
    public virtual int EndOffset { get; }
    Property Value
    Type Description
    int

    Next

    Returns the next TermInfo at this same position. This is a circular list!

    Declaration
    public virtual FieldTermStack.TermInfo Next { get; }
    Property Value
    Type Description
    FieldTermStack.TermInfo

    Position

    Single term with its position/offsets in the document and IDF weight. It is IComparable<T> but considers only position.

    Declaration
    public virtual int Position { get; }
    Property Value
    Type Description
    int

    StartOffset

    Single term with its position/offsets in the document and IDF weight. It is IComparable<T> but considers only position.

    Declaration
    public virtual int StartOffset { get; }
    Property Value
    Type Description
    int

    Text

    Single term with its position/offsets in the document and IDF weight. It is IComparable<T> but considers only position.

    Declaration
    public virtual string Text { get; }
    Property Value
    Type Description
    string

    Weight

    Single term with its position/offsets in the document and IDF weight. It is IComparable<T> but considers only position.

    Declaration
    public virtual float Weight { get; }
    Property Value
    Type Description
    float

    Methods

    CompareTo(TermInfo)

    Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

    Declaration
    public virtual int CompareTo(FieldTermStack.TermInfo o)
    Parameters
    Type Name Description
    FieldTermStack.TermInfo o
    Returns
    Type Description
    int

    A value that indicates the relative order of the objects being compared. The return value has these meanings:

    Value Meaning
    Less than zero This instance precedes other in the sort order.
    Zero This instance occurs in the same position in the sort order as other.
    Greater than zero This instance follows other in the sort order.

    Equals(object)

    Determines whether the specified object is equal to the current object.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current object.

    Returns
    Type Description
    bool

    true if the specified object is equal to the current object; otherwise, false.

    Overrides
    object.Equals(object)

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    object.ToString()

    Implements

    IComparable<T>
    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.