Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class FieldQueryNode

    A FieldQueryNode represents a element that contains field/text tuple

    Inheritance
    object
    QueryNode
    FieldQueryNode
    FuzzyQueryNode
    QuotedFieldQueryNode
    WildcardQueryNode
    Implements
    IFieldValuePairQueryNode<string>
    IFieldableNode
    IValueQueryNode<string>
    IQueryNode
    ITextableQueryNode
    Inherited Members
    QueryNode.PLAINTEXT_FIELD_NAME
    QueryNode.Allocate()
    QueryNode.Add(IQueryNode)
    QueryNode.Add(IList<IQueryNode>)
    QueryNode.IsLeaf
    QueryNode.Set(IList<IQueryNode>)
    QueryNode.Clone()
    QueryNode.GetChildren()
    QueryNode.SetTag(string, object)
    QueryNode.UnsetTag(string)
    QueryNode.ContainsTag(string)
    QueryNode.GetTag(string)
    QueryNode.TryGetTag(string, out object)
    QueryNode.Parent
    QueryNode.IsRoot
    QueryNode.m_toQueryStringIgnoreFields
    QueryNode.IsDefaultField(string)
    QueryNode.TagMap
    QueryNode.RemoveChildren(IQueryNode)
    QueryNode.RemoveFromParent()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Lucene.Net.QueryParsers.Flexible.Core.Nodes
    Assembly: Lucene.Net.QueryParser.dll
    Syntax
    public class FieldQueryNode : QueryNode, IFieldValuePairQueryNode<string>, IFieldableNode, IValueQueryNode<string>, IQueryNode, ITextableQueryNode

    Constructors

    FieldQueryNode(string, ICharSequence, int, int)

    A FieldQueryNode represents a element that contains field/text tuple

    Declaration
    public FieldQueryNode(string field, ICharSequence text, int begin, int end)
    Parameters
    Type Name Description
    string field

    field name

    ICharSequence text

    value

    int begin

    position in the query string

    int end

    position in the query string

    FieldQueryNode(string, string, int, int)

    A FieldQueryNode represents a element that contains field/text tuple

    Declaration
    public FieldQueryNode(string field, string text, int begin, int end)
    Parameters
    Type Name Description
    string field

    field name

    string text

    value

    int begin

    position in the query string

    int end

    position in the query string

    FieldQueryNode(string, StringBuilder, int, int)

    A FieldQueryNode represents a element that contains field/text tuple

    Declaration
    public FieldQueryNode(string field, StringBuilder text, int begin, int end)
    Parameters
    Type Name Description
    string field

    field name

    StringBuilder text

    value

    int begin

    position in the query string

    int end

    position in the query string

    Fields

    m_begin

    The term's begin position.

    Declaration
    protected int m_begin
    Field Value
    Type Description
    int

    m_end

    The term's end position.

    Declaration
    protected int m_end
    Field Value
    Type Description
    int

    m_field

    The term's field

    Declaration
    protected string m_field
    Field Value
    Type Description
    string

    m_positionIncrement

    The term's position increment.

    Declaration
    protected int m_positionIncrement
    Field Value
    Type Description
    int

    m_text

    The term's text.

    Declaration
    protected ICharSequence m_text
    Field Value
    Type Description
    ICharSequence

    Properties

    Begin

    A FieldQueryNode represents a element that contains field/text tuple

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

    End

    A FieldQueryNode represents a element that contains field/text tuple

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

    Field

    Gets or Sets the field name associated to the node and every node under it.

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

    PositionIncrement

    A FieldQueryNode represents a element that contains field/text tuple

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

    Text

    Gets or Sets the "original" form of the term.

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

    Value

    A FieldQueryNode represents a element that contains field/text tuple

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

    Methods

    CloneTree()

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

    Declaration
    public override IQueryNode CloneTree()
    Returns
    Type Description
    IQueryNode

    the cloned tree

    Overrides
    QueryNode.CloneTree()

    GetFieldAsString()

    null if the field was not specified in the query string

    Declaration
    public virtual string GetFieldAsString()
    Returns
    Type Description
    string

    the field

    GetTermEscapeQuoted(IEscapeQuerySyntax)

    A FieldQueryNode represents a element that contains field/text tuple

    Declaration
    protected virtual string GetTermEscapeQuoted(IEscapeQuerySyntax escaper)
    Parameters
    Type Name Description
    IEscapeQuerySyntax escaper
    Returns
    Type Description
    string

    GetTermEscaped(IEscapeQuerySyntax)

    A FieldQueryNode represents a element that contains field/text tuple

    Declaration
    protected virtual string GetTermEscaped(IEscapeQuerySyntax escaper)
    Parameters
    Type Name Description
    IEscapeQuerySyntax escaper
    Returns
    Type Description
    string

    GetTextAsString()

    A FieldQueryNode represents a element that contains field/text tuple

    Declaration
    public virtual string GetTextAsString()
    Returns
    Type Description
    string

    the term

    ToQueryString(IEscapeQuerySyntax)

    convert to a query string understood by the query parser

    Declaration
    public override string ToQueryString(IEscapeQuerySyntax escaper)
    Parameters
    Type Name Description
    IEscapeQuerySyntax escaper
    Returns
    Type Description
    string
    Overrides
    QueryNode.ToQueryString(IEscapeQuerySyntax)

    ToString()

    Every implementation of this class should return pseudo xml like this:

    For FieldQueryNode: <field start='1' end='2' field='subject' text='foo'/>

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    QueryNode.ToString()
    See Also
    ToString()

    Implements

    IFieldValuePairQueryNode<T>
    IFieldableNode
    IValueQueryNode<T>
    IQueryNode
    ITextableQueryNode
    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.