Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class SimpleTerm

    Base class for queries that expand to sets of simple terms.

    Inheritance
    object
    SrndQuery
    SimpleTerm
    SrndPrefixQuery
    SrndTermQuery
    SrndTruncQuery
    Implements
    IDistanceSubQuery
    IComparable<SimpleTerm>
    Inherited Members
    SrndQuery.IsWeighted
    SrndQuery.Weight
    SrndQuery.WeightString
    SrndQuery.WeightOperator
    SrndQuery.WeightToString(StringBuilder)
    SrndQuery.MakeLuceneQueryField(string, BasicQueryFactory)
    SrndQuery.IsFieldsSubQueryAcceptable
    SrndQuery.Clone()
    SrndQuery.GetHashCode()
    SrndQuery.Equals(object)
    SrndQuery.TheEmptyLcnQuery
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.QueryParsers.Surround.Query
    Assembly: Lucene.Net.QueryParser.dll
    Syntax
    public abstract class SimpleTerm : SrndQuery, IDistanceSubQuery, IComparable<SimpleTerm>

    Constructors

    SimpleTerm(bool)

    Base class for queries that expand to sets of simple terms.

    Declaration
    protected SimpleTerm(bool quoted)
    Parameters
    Type Name Description
    bool quoted

    Properties

    FieldOperator

    Base class for queries that expand to sets of simple terms.

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

    Quote

    Base class for queries that expand to sets of simple terms.

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

    Methods

    AddSpanQueries(SpanNearClauseFactory)

    Base class for queries that expand to sets of simple terms.

    Declaration
    public virtual void AddSpanQueries(SpanNearClauseFactory sncf)
    Parameters
    Type Name Description
    SpanNearClauseFactory sncf

    CompareTo(SimpleTerm)

    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
    [Obsolete("deprecated (March 2011) Not normally used, to be removed from Lucene 4.0. This class implementing Comparable is to be removed at the same time.")]
    public int CompareTo(SimpleTerm ost)
    Parameters
    Type Name Description
    SimpleTerm ost
    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.

    DistanceSubQueryNotAllowed()

    When DistanceSubQueryNotAllowed() returns non null, the reason why the subquery is not allowed as a distance subquery is returned.

    When DistanceSubQueryNotAllowed() returns null AddSpanQueries(SpanNearClauseFactory) can be used in the creation of the span near clause for the subquery.
    Declaration
    public virtual string DistanceSubQueryNotAllowed()
    Returns
    Type Description
    string

    MakeLuceneQueryFieldNoBoost(string, BasicQueryFactory)

    Base class for queries that expand to sets of simple terms.

    Declaration
    public override Query MakeLuceneQueryFieldNoBoost(string fieldName, BasicQueryFactory qf)
    Parameters
    Type Name Description
    string fieldName
    BasicQueryFactory qf
    Returns
    Type Description
    Query
    Overrides
    SrndQuery.MakeLuceneQueryFieldNoBoost(string, BasicQueryFactory)

    SuffixToString(StringBuilder)

    Base class for queries that expand to sets of simple terms.

    Declaration
    protected virtual void SuffixToString(StringBuilder r)
    Parameters
    Type Name Description
    StringBuilder r

    ToString()

    This method is used by GetHashCode() and Equals(object), see LUCENE-2945.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    SrndQuery.ToString()

    ToStringUnquoted()

    Base class for queries that expand to sets of simple terms.

    Declaration
    public abstract string ToStringUnquoted()
    Returns
    Type Description
    string

    VisitMatchingTerms(IndexReader, string, IMatchingTermVisitor)

    Base class for queries that expand to sets of simple terms.

    Declaration
    public abstract void VisitMatchingTerms(IndexReader reader, string fieldName, SimpleTerm.IMatchingTermVisitor mtv)
    Parameters
    Type Name Description
    IndexReader reader
    string fieldName
    SimpleTerm.IMatchingTermVisitor mtv

    Implements

    IDistanceSubQuery
    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.