Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class QueryNodeProcessorPipeline

    A QueryNodeProcessorPipeline class should be used to build a query node processor pipeline.

    When a query node tree is processed using this class, it passes the query node tree to each processor on the pipeline and the result from each processor is passed to the next one, always following the order the processors were on the pipeline.

    When a QueryConfigHandler object is set on a QueryNodeProcessorPipeline, it also takes care of setting this QueryConfigHandler on all processor on pipeline.
    Inheritance
    object
    QueryNodeProcessorPipeline
    StandardQueryNodeProcessorPipeline
    Implements
    IQueryNodeProcessor
    IList<IQueryNodeProcessor>
    ICollection<IQueryNodeProcessor>
    IEnumerable<IQueryNodeProcessor>
    IEnumerable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Lucene.Net.QueryParsers.Flexible.Core.Processors
    Assembly: Lucene.Net.QueryParser.dll
    Syntax
    public class QueryNodeProcessorPipeline : IQueryNodeProcessor, IList<IQueryNodeProcessor>, ICollection<IQueryNodeProcessor>, IEnumerable<IQueryNodeProcessor>, IEnumerable

    Constructors

    QueryNodeProcessorPipeline()

    Constructs an empty query node processor pipeline.

    Declaration
    public QueryNodeProcessorPipeline()

    QueryNodeProcessorPipeline(QueryConfigHandler)

    Constructs with a QueryConfigHandler object.

    Declaration
    public QueryNodeProcessorPipeline(QueryConfigHandler queryConfigHandler)
    Parameters
    Type Name Description
    QueryConfigHandler queryConfigHandler

    Properties

    Count

    Count

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

    IsReadOnly

    IsReadOnly

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

    this[int]

    this[int]

    Declaration
    public virtual IQueryNodeProcessor this[int index] { get; set; }
    Parameters
    Type Name Description
    int index
    Property Value
    Type Description
    IQueryNodeProcessor

    Methods

    Add(IQueryNodeProcessor)

    Add(T)

    Declaration
    public virtual bool Add(IQueryNodeProcessor processor)
    Parameters
    Type Name Description
    IQueryNodeProcessor processor
    Returns
    Type Description
    bool

    Clear()

    Clear()

    Declaration
    public virtual void Clear()

    Contains(IQueryNodeProcessor)

    Contains(T)

    Declaration
    public virtual bool Contains(IQueryNodeProcessor item)
    Parameters
    Type Name Description
    IQueryNodeProcessor item
    Returns
    Type Description
    bool

    Contains(object)

    A QueryNodeProcessorPipeline class should be used to build a query node processor pipeline.

    When a query node tree is processed using this class, it passes the query node tree to each processor on the pipeline and the result from each processor is passed to the next one, always following the order the processors were on the pipeline.

    When a QueryConfigHandler object is set on a QueryNodeProcessorPipeline, it also takes care of setting this QueryConfigHandler on all processor on pipeline.
    Declaration
    public virtual bool Contains(object o)
    Parameters
    Type Name Description
    object o
    Returns
    Type Description
    bool

    CopyTo(IQueryNodeProcessor[], int)

    CopyTo(T[], int)

    Declaration
    public virtual void CopyTo(IQueryNodeProcessor[] array, int arrayIndex)
    Parameters
    Type Name Description
    IQueryNodeProcessor[] array
    int arrayIndex

    GetEnumerator()

    GetEnumerator()

    Declaration
    public virtual IEnumerator<IQueryNodeProcessor> GetEnumerator()
    Returns
    Type Description
    IEnumerator<IQueryNodeProcessor>

    GetQueryConfigHandler()

    For reference about this method check: GetQueryConfigHandler().

    Declaration
    public virtual QueryConfigHandler GetQueryConfigHandler()
    Returns
    Type Description
    QueryConfigHandler

    QueryConfigHandler the query configuration handler to be set.

    See Also
    SetQueryConfigHandler(QueryConfigHandler)
    QueryConfigHandler

    GetRange(int, int)

    A QueryNodeProcessorPipeline class should be used to build a query node processor pipeline.

    When a query node tree is processed using this class, it passes the query node tree to each processor on the pipeline and the result from each processor is passed to the next one, always following the order the processors were on the pipeline.

    When a QueryConfigHandler object is set on a QueryNodeProcessorPipeline, it also takes care of setting this QueryConfigHandler on all processor on pipeline.
    Declaration
    public virtual IList<IQueryNodeProcessor> GetRange(int index, int count)
    Parameters
    Type Name Description
    int index
    int count
    Returns
    Type Description
    IList<IQueryNodeProcessor>

    GetView(int, int)

    GetView(int, int)

    Declaration
    public virtual IList<IQueryNodeProcessor> GetView(int index, int count)
    Parameters
    Type Name Description
    int index
    int count
    Returns
    Type Description
    IList<IQueryNodeProcessor>

    IndexOf(IQueryNodeProcessor)

    IndexOf(T)

    Declaration
    public virtual int IndexOf(IQueryNodeProcessor o)
    Parameters
    Type Name Description
    IQueryNodeProcessor o
    Returns
    Type Description
    int

    Insert(int, IQueryNodeProcessor)

    Inserts an item to the IList<T> at the specified index.

    Declaration
    public virtual void Insert(int index, IQueryNodeProcessor item)
    Parameters
    Type Name Description
    int index

    The zero-based index at which item should be inserted.

    IQueryNodeProcessor item

    The object to insert into the IList<T>.

    Exceptions
    Type Condition
    ArgumentOutOfRangeException

    index is not a valid index in the IList<T>.

    NotSupportedException

    The IList<T> is read-only.

    Process(IQueryNode)

    For reference about this method check: Process(IQueryNode).

    Declaration
    public virtual IQueryNode Process(IQueryNode queryTree)
    Parameters
    Type Name Description
    IQueryNode queryTree

    the query node tree to be processed

    Returns
    Type Description
    IQueryNode
    Exceptions
    Type Condition
    QueryNodeException

    if something goes wrong during the query node processing

    See Also
    IQueryNode

    Remove(IQueryNodeProcessor)

    Remove(T)

    Declaration
    public virtual bool Remove(IQueryNodeProcessor o)
    Parameters
    Type Name Description
    IQueryNodeProcessor o
    Returns
    Type Description
    bool

    RemoveAt(int)

    RemoveAt(int)

    Declaration
    public virtual void RemoveAt(int index)
    Parameters
    Type Name Description
    int index

    RemoveRange(int, int)

    A QueryNodeProcessorPipeline class should be used to build a query node processor pipeline.

    When a query node tree is processed using this class, it passes the query node tree to each processor on the pipeline and the result from each processor is passed to the next one, always following the order the processors were on the pipeline.

    When a QueryConfigHandler object is set on a QueryNodeProcessorPipeline, it also takes care of setting this QueryConfigHandler on all processor on pipeline.
    Declaration
    public virtual void RemoveRange(int index, int count)
    Parameters
    Type Name Description
    int index
    int count

    Set(int, IQueryNodeProcessor)

    A QueryNodeProcessorPipeline class should be used to build a query node processor pipeline.

    When a query node tree is processed using this class, it passes the query node tree to each processor on the pipeline and the result from each processor is passed to the next one, always following the order the processors were on the pipeline.

    When a QueryConfigHandler object is set on a QueryNodeProcessorPipeline, it also takes care of setting this QueryConfigHandler on all processor on pipeline.
    Declaration
    public virtual IQueryNodeProcessor Set(int index, IQueryNodeProcessor processor)
    Parameters
    Type Name Description
    int index
    IQueryNodeProcessor processor
    Returns
    Type Description
    IQueryNodeProcessor

    SetQueryConfigHandler(QueryConfigHandler)

    For reference about this method check: SetQueryConfigHandler(QueryConfigHandler).

    Declaration
    public virtual void SetQueryConfigHandler(QueryConfigHandler queryConfigHandler)
    Parameters
    Type Name Description
    QueryConfigHandler queryConfigHandler

    the query configuration handler to be set.

    See Also
    GetQueryConfigHandler()
    QueryConfigHandler

    Implements

    IQueryNodeProcessor
    IList<T>
    ICollection<T>
    IEnumerable<T>
    IEnumerable
    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.