Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SpanFirstQuery

    Matches spans near the beginning of a field.

    This class is a simple extension of SpanPositionRangeQuery in that it assumes the start to be zero and only checks the end boundary.
    Inheritance
    object
    Query
    SpanQuery
    SpanPositionCheckQuery
    SpanPositionRangeQuery
    SpanFirstQuery
    Inherited Members
    SpanPositionRangeQuery.m_start
    SpanPositionRangeQuery.m_end
    SpanPositionRangeQuery.Start
    SpanPositionRangeQuery.End
    SpanPositionCheckQuery.m_match
    SpanPositionCheckQuery.Match
    SpanPositionCheckQuery.Field
    SpanPositionCheckQuery.ExtractTerms(ISet<Term>)
    SpanPositionCheckQuery.GetSpans(AtomicReaderContext, IBits, IDictionary<Term, TermContext>)
    SpanPositionCheckQuery.Rewrite(IndexReader)
    SpanQuery.CreateWeight(IndexSearcher)
    Query.Boost
    Query.ToString()
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search.Spans
    Assembly: Lucene.Net.dll
    Syntax
    public class SpanFirstQuery : SpanPositionRangeQuery

    Constructors

    SpanFirstQuery(SpanQuery, int)

    Construct a SpanFirstQuery matching spans in match whose end position is less than or equal to end.

    Declaration
    public SpanFirstQuery(SpanQuery match, int end)
    Parameters
    Type Name Description
    SpanQuery match
    int end

    Methods

    AcceptPosition(Spans)

    Implementing classes are required to return whether the current position is a match for the passed in "match" SpanQuery.

    This is only called if the underlying MoveNext() for the match is successful
    Declaration
    protected override SpanPositionCheckQuery.AcceptStatus AcceptPosition(Spans spans)
    Parameters
    Type Name Description
    Spans spans

    The Spans instance, positioned at the spot to check

    Returns
    Type Description
    SpanPositionCheckQuery.AcceptStatus

    Whether the match is accepted, rejected, or rejected and should move to the next doc.

    Overrides
    SpanPositionRangeQuery.AcceptPosition(Spans)
    See Also
    MoveNext()

    Clone()

    Returns a clone of this query.

    Declaration
    public override object Clone()
    Returns
    Type Description
    object
    Overrides
    SpanPositionRangeQuery.Clone()

    Equals(object)

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

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

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

    Overrides
    SpanPositionRangeQuery.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
    SpanPositionRangeQuery.GetHashCode()

    ToString(string)

    Prints a query to a string, with field assumed to be the default field and omitted.

    Declaration
    public override string ToString(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    string
    Overrides
    SpanPositionRangeQuery.ToString(string)
    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.