Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class BooleanClause

    A clause in a BooleanQuery.

    Inheritance
    object
    BooleanClause
    Implements
    IEquatable<BooleanClause>
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.Search
    Assembly: Lucene.Net.dll
    Syntax
    public class BooleanClause : IEquatable<BooleanClause>

    Constructors

    BooleanClause(Query, Occur)

    Constructs a BooleanClause.

    Declaration
    public BooleanClause(Query query, Occur occur)
    Parameters
    Type Name Description
    Query query
    Occur occur

    Properties

    IsProhibited

    A clause in a BooleanQuery.

    Declaration
    public virtual bool IsProhibited { get; }
    Property Value
    Type Description
    bool

    IsRequired

    A clause in a BooleanQuery.

    Declaration
    public virtual bool IsRequired { get; }
    Property Value
    Type Description
    bool

    Occur

    A clause in a BooleanQuery.

    Declaration
    public virtual Occur Occur { get; set; }
    Property Value
    Type Description
    Occur

    Query

    A clause in a BooleanQuery.

    Declaration
    public virtual Query Query { get; set; }
    Property Value
    Type Description
    Query

    Methods

    Equals(BooleanClause)

    Indicates whether the current object is equal to another object of the same type.

    Declaration
    public bool Equals(BooleanClause other)
    Parameters
    Type Name Description
    BooleanClause other

    An object to compare with this object.

    Returns
    Type Description
    bool

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

    Equals(object)

    Returns true if o is equal to this.

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

    GetHashCode()

    Returns a hash code value for this object.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    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()

    ToString(Occur)

    A clause in a BooleanQuery.

    Declaration
    public static string ToString(Occur occur)
    Parameters
    Type Name Description
    Occur occur
    Returns
    Type Description
    string

    Implements

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