Show / Hide Table of Contents

    Class SpanPayloadCheckQuery

    Only return those matches that have a specific payload at the given position.

    Do not use this with a SpanQuery that contains a SpanNearQuery. Instead, use SpanNearPayloadCheckQuery since it properly handles the fact that payloads aren't ordered by SpanNearQuery.

    Inheritance
    System.Object
    Query
    SpanQuery
    SpanPositionCheckQuery
    SpanPayloadCheckQuery
    Inherited Members
    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()
    Namespace: Lucene.Net.Search.Spans
    Assembly: Lucene.Net.dll
    Syntax
    public class SpanPayloadCheckQuery : SpanPositionCheckQuery

    Constructors

    | Improve this Doc View Source

    SpanPayloadCheckQuery(SpanQuery, ICollection<Byte[]>)

    Declaration
    public SpanPayloadCheckQuery(SpanQuery match, ICollection<byte[]> payloadToMatch)
    Parameters
    Type Name Description
    SpanQuery match

    The underlying SpanQuery to check

    ICollection<System.Byte[]> payloadToMatch

    The ICollection{byte[]} of payloads to match. IMPORTANT: If the type provided does not implement (including arrays), , or , it should provide an and implementation that compares the values of the byte arrays to ensure they are the same.

    Fields

    | Improve this Doc View Source

    m_payloadToMatch

    Declaration
    protected readonly ICollection<byte[]> m_payloadToMatch
    Field Value
    Type Description
    ICollection<System.Byte[]>

    Methods

    | Improve this Doc View Source

    AcceptPosition(Spans)

    Declaration
    protected override SpanPositionCheckQuery.AcceptStatus AcceptPosition(Spans spans)
    Parameters
    Type Name Description
    Spans spans
    Returns
    Type Description
    SpanPositionCheckQuery.AcceptStatus
    Overrides
    SpanPositionCheckQuery.AcceptPosition(Spans)
    | Improve this Doc View Source

    Clone()

    Declaration
    public override object Clone()
    Returns
    Type Description
    System.Object
    Overrides
    Query.Clone()
    | Improve this Doc View Source

    Equals(Object)

    Declaration
    public override bool Equals(object o)
    Parameters
    Type Name Description
    System.Object o
    Returns
    Type Description
    System.Boolean
    Overrides
    Query.Equals(Object)
    | Improve this Doc View Source

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    System.Int32
    Overrides
    Query.GetHashCode()
    | Improve this Doc View Source

    ToString(String)

    Declaration
    public override string ToString(string field)
    Parameters
    Type Name Description
    System.String field
    Returns
    Type Description
    System.String
    Overrides
    Query.ToString(String)
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)