Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Class StandardSyntaxParser

    Parser for the standard Lucene syntax

    Inheritance
    object
    StandardSyntaxParser
    Implements
    ISyntaxParser
    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.Standard.Parser
    Assembly: Lucene.Net.QueryParser.dll
    Syntax
    public class StandardSyntaxParser : ISyntaxParser

    Constructors

    StandardSyntaxParser()

    Parser for the standard Lucene syntax

    Declaration
    public StandardSyntaxParser()

    StandardSyntaxParser(ICharStream)

    Constructor with user supplied ICharStream.

    Declaration
    public StandardSyntaxParser(ICharStream stream)
    Parameters
    Type Name Description
    ICharStream stream

    StandardSyntaxParser(StandardSyntaxParserTokenManager)

    Constructor with generated Token Manager.

    Declaration
    public StandardSyntaxParser(StandardSyntaxParserTokenManager tm)
    Parameters
    Type Name Description
    StandardSyntaxParserTokenManager tm

    Properties

    Jj_nt

    Next token.

    Declaration
    public Token Jj_nt { get; set; }
    Property Value
    Type Description
    Token

    Token

    Current token.

    Declaration
    public Token Token { get; set; }
    Property Value
    Type Description
    Token

    TokenSource

    Generated Token Manager.

    Declaration
    public StandardSyntaxParserTokenManager TokenSource { get; set; }
    Property Value
    Type Description
    StandardSyntaxParserTokenManager

    Methods

    Clause(string)

    Parser for the standard Lucene syntax

    Declaration
    public IQueryNode Clause(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    IQueryNode

    ConjQuery(string)

    Parser for the standard Lucene syntax

    Declaration
    public IQueryNode ConjQuery(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    IQueryNode

    Conjunction()

    Parser for the standard Lucene syntax

    Declaration
    public int Conjunction()
    Returns
    Type Description
    int

    Disable_tracing()

    Disable tracing.

    Declaration
    public void Disable_tracing()

    DisjQuery(string)

    Parser for the standard Lucene syntax

    Declaration
    public IQueryNode DisjQuery(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    IQueryNode

    Enable_tracing()

    Enable tracing.

    Declaration
    public void Enable_tracing()

    GenerateParseException()

    Generate ParseException.

    Declaration
    public virtual ParseException GenerateParseException()
    Returns
    Type Description
    ParseException

    GetNextToken()

    Get the next Token.

    Declaration
    public Token GetNextToken()
    Returns
    Type Description
    Token

    GetToken(int)

    Get the specific Token.

    Declaration
    public Token GetToken(int index)
    Parameters
    Type Name Description
    int index
    Returns
    Type Description
    Token

    ModClause(string)

    Parser for the standard Lucene syntax

    Declaration
    public IQueryNode ModClause(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    IQueryNode

    Modifiers()

    Parser for the standard Lucene syntax

    Declaration
    public Modifier Modifiers()
    Returns
    Type Description
    Modifier

    Parse(string, string)

    Parses a query string, returning a IQueryNode.

    Declaration
    public IQueryNode Parse(string query, string field)
    Parameters
    Type Name Description
    string query

    the query string to be parsed.

    string field
    Returns
    Type Description
    IQueryNode
    Exceptions
    Type Condition
    ParseException

    if the parsing fails

    Query(string)

    Parser for the standard Lucene syntax

    Declaration
    public IQueryNode Query(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    IQueryNode

    ReInit(ICharStream)

    Reinitialize.

    Declaration
    public void ReInit(ICharStream stream)
    Parameters
    Type Name Description
    ICharStream stream

    ReInit(StandardSyntaxParserTokenManager)

    Reinitialize.

    Declaration
    public void ReInit(StandardSyntaxParserTokenManager tm)
    Parameters
    Type Name Description
    StandardSyntaxParserTokenManager tm

    Term(string)

    Parser for the standard Lucene syntax

    Declaration
    public IQueryNode Term(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    IQueryNode

    TopLevelQuery(string)

    Parser for the standard Lucene syntax

    Declaration
    public IQueryNode TopLevelQuery(string field)
    Parameters
    Type Name Description
    string field
    Returns
    Type Description
    IQueryNode

    Implements

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