Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Interface IQueryNode

    A IQueryNode is a interface implemented by all nodes on a IQueryNode tree.

    Namespace: Lucene.Net.QueryParsers.Flexible.Core.Nodes
    Assembly: Lucene.Net.QueryParser.dll
    Syntax
    public interface IQueryNode

    Properties

    | Improve this Doc View Source

    IsLeaf

    verify if a node is a Leaf node

    Declaration
    bool IsLeaf { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Parent

    Declaration
    IQueryNode Parent { get; }
    Property Value
    Type Description
    IQueryNode
    | Improve this Doc View Source

    TagMap

    Gets a map containing all tags attached to this query node.

    Declaration
    IDictionary<string, object> TagMap { get; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    Methods

    | Improve this Doc View Source

    Add(IQueryNode)

    add a new child to a non Leaf node

    Declaration
    void Add(IQueryNode child)
    Parameters
    Type Name Description
    IQueryNode child
    | Improve this Doc View Source

    Add(IList<IQueryNode>)

    Declaration
    void Add(IList<IQueryNode> children)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<IQueryNode> children
    | Improve this Doc View Source

    CloneTree()

    Recursive clone the IQueryNode tree. The tags are not copied to the new tree when you call the CloneTree() method.

    Declaration
    IQueryNode CloneTree()
    Returns
    Type Description
    IQueryNode

    the cloned tree

    | Improve this Doc View Source

    ContainsTag(String)

    verify if a node contains a tag

    Declaration
    bool ContainsTag(string tagName)
    Parameters
    Type Name Description
    System.String tagName
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    GetChildren()

    get Children nodes

    Declaration
    IList<IQueryNode> GetChildren()
    Returns
    Type Description
    System.Collections.Generic.IList<IQueryNode>
    | Improve this Doc View Source

    GetTag(String)

    Returns object stored under that tag name

    Declaration
    object GetTag(string tagName)
    Parameters
    Type Name Description
    System.String tagName
    Returns
    Type Description
    System.Object
    | Improve this Doc View Source

    RemoveChildren(IQueryNode)

    Remove a child node.

    Declaration
    void RemoveChildren(IQueryNode childNode)
    Parameters
    Type Name Description
    IQueryNode childNode

    Which child to remove.

    | Improve this Doc View Source

    RemoveFromParent()

    Removes this query node from its parent.

    Declaration
    void RemoveFromParent()
    | Improve this Doc View Source

    Set(IList<IQueryNode>)

    reset the children of a node

    Declaration
    void Set(IList<IQueryNode> children)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<IQueryNode> children
    | Improve this Doc View Source

    SetTag(String, Object)

    Associate the specified value with the specified tagName. If the tagName already exists, the old value is replaced. The tagName and value cannot be null. tagName will be converted to lowercase.

    Declaration
    void SetTag(string tagName, object value)
    Parameters
    Type Name Description
    System.String tagName
    System.Object value
    | Improve this Doc View Source

    ToQueryString(IEscapeQuerySyntax)

    convert to a query string understood by the query parser

    Declaration
    string ToQueryString(IEscapeQuerySyntax escapeSyntaxParser)
    Parameters
    Type Name Description
    IEscapeQuerySyntax escapeSyntaxParser
    Returns
    Type Description
    System.String
    | Improve this Doc View Source

    ToString()

    for printing

    Declaration
    string ToString()
    Returns
    Type Description
    System.String
    | Improve this Doc View Source

    TryGetTag(String, out Object)

    Gets the tag associated with the specified tagName.

    Declaration
    bool TryGetTag(string tagName, out object tag)
    Parameters
    Type Name Description
    System.String tagName
    System.Object tag
    Returns
    Type Description
    System.Boolean
    | Improve this Doc View Source

    UnsetTag(String)

    Unset a tag. tagName will be converted to lowercase.

    Declaration
    void UnsetTag(string tagName)
    Parameters
    Type Name Description
    System.String tagName
    • Improve this Doc
    • View Source
    Back to top Copyright © 2022 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.