\Zend_Search_Lucene_Search_QueryParser
- Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- License: http://framework.zend.com/license/new-bsd New BSD License
Synopsis
class Zend_Search_Lucene_Search_QueryParser
extends Zend_Search_Lucene_FSM
{
- // constants
- const B_OR = 0;
- const B_AND = 1;
- const ST_COMMON_QUERY_ELEMENT = 0;
- const ST_CLOSEDINT_RQ_START = 1;
- const ST_CLOSEDINT_RQ_FIRST_TERM = 2;
- const ST_CLOSEDINT_RQ_TO_TERM = 3;
- const ST_CLOSEDINT_RQ_LAST_TERM = 4;
- const ST_CLOSEDINT_RQ_END = 5;
- const ST_OPENEDINT_RQ_START = 6;
- const ST_OPENEDINT_RQ_FIRST_TERM = 7;
- const ST_OPENEDINT_RQ_TO_TERM = 8;
- const ST_OPENEDINT_RQ_LAST_TERM = 9;
- const ST_OPENEDINT_RQ_END = 10;
- // members
- private static Zend_Search_Lucene_Search_QueryParser $_instance = NULL;
- private Zend_Search_Lucene_Search_QueryLexer $_lexer;
- private $_tokens;
- private integer|string $_currentToken;
- private Zend_Search_Lucene_Search_QueryToken $_lastToken = NULL;
- private $_rqFirstTerm = NULL;
- private Zend_Search_Lucene_Search_QueryParserContext $_context;
- private $_contextStack;
- private $_encoding;
- private string $_defaultEncoding = '';
- private boolean $_suppressQueryParsingExceptions = true;
- private integer $_defaultOperator = self::B_OR;
- // methods
- public void __construct()
- private static Zend_Search_Lucene_Search_QueryParser _getInstance()
- public static void setDefaultEncoding()
- public static string getDefaultEncoding()
- public static void setDefaultOperator()
- public static integer getDefaultOperator()
- public static void suppressQueryParsingExceptions()
- public static void dontSuppressQueryParsingExceptions()
- public static boolean queryParsingExceptionsSuppressed()
- public static string escape()
- public static Zend_Search_Lucene_Search_Query parse()
- public void addTermEntry()
- public void addPhraseEntry()
- public void setField()
- public void setSign()
- public void processFuzzyProximityModifier()
- public void processModifierParameter()
- public void subqueryStart()
- public void subqueryEnd()
- public void logicalOperator()
- public void openedRQFirstTerm()
- public void openedRQLastTerm()
- public void closedRQFirstTerm()
- public void closedRQLastTerm()
- // Inherited methods from Zend_Search_Lucene_FSM
- public void __construct()
- public void addStates()
- public void addState()
- public void setState()
- public integer|string getState()
- public void addInputSymbols()
- public void addInputSymbol()
- public void addRules()
- public void addRule()
- public void addEntryAction()
- public void addExitAction()
- public void addInputAction()
- public void addTransitionAction()
- public void process()
- public void reset()
Hierarchy
Extends
Constants
Name | Value |
---|---|
B_OR | 0 |
B_AND | 1 |
ST_COMMON_QUERY_ELEMENT | 0 |
ST_CLOSEDINT_RQ_START | 1 |
ST_CLOSEDINT_RQ_FIRST_TERM | 2 |
ST_CLOSEDINT_RQ_TO_TERM | 3 |
ST_CLOSEDINT_RQ_LAST_TERM | 4 |
ST_CLOSEDINT_RQ_END | 5 |
ST_OPENEDINT_RQ_START | 6 |
ST_OPENEDINT_RQ_FIRST_TERM | 7 |
ST_OPENEDINT_RQ_TO_TERM | 8 |
ST_OPENEDINT_RQ_LAST_TERM | 9 |
ST_OPENEDINT_RQ_END | 10 |
Members
private
- $_context
—
Zend_Search_Lucene_Search_QueryParserContext
Current query parser context - $_contextStack
—
array
Context stack - $_currentToken
—
integer|string
Current token - $_defaultEncoding
—
string
Query string default encoding - $_defaultOperator
—
integer
Default boolean queries operator - $_encoding
—
string
Query string encoding - $_instance
—
Zend_Search_Lucene_Search_QueryParser
Parser instance - $_lastToken
—
Zend_Search_Lucene_Search_QueryToken
Last token - $_lexer
—
Zend_Search_Lucene_Search_QueryLexer
Query lexer - $_rqFirstTerm
—
string
Range query first term - $_suppressQueryParsingExceptions
—
boolean
Defines query parsing mode. - $_tokens
—
array
Tokens list Array of Zend_Search_Lucene_Search_QueryToken objects
Methods
private
- _getInstance() — Get query parser instance
public
- __construct() — Parser constructor
- addPhraseEntry() — Add phrase to a query
- addTermEntry() — Add term to a query
- closedRQFirstTerm() — Process first range query term (closed interval)
- closedRQLastTerm() — Process last range query term (closed interval)
- dontSuppressQueryParsingExceptions() — Turn off 'suppress query parser exceptions' mode.
- escape() — Escape keyword to force it to be parsed as one term
- getDefaultEncoding() — Get query string default encoding
- getDefaultOperator() — Get default boolean operator
- logicalOperator() — Process logical operator
- openedRQFirstTerm() — Process first range query term (opened interval)
- openedRQLastTerm() — Process last range query term (opened interval)
- parse() — Parses a query string
- processFuzzyProximityModifier() — Process fuzzy search/proximity modifier - '~'
- processModifierParameter() — Process modifier parameter
- queryParsingExceptionsSuppressed() — Check 'suppress query parser exceptions' mode.
- setDefaultEncoding() — Set query string default encoding
- setDefaultOperator() — Set default boolean operator
- setField() — Set entry field
- setSign() — Set entry sign
- subqueryEnd() — End subquery
- subqueryStart() — Start subquery
- suppressQueryParsingExceptions() — Turn on 'suppress query parser exceptions' mode.
Inherited from Zend_Search_Lucene_FSM
public
- addEntryAction() — Add state entry action.
- addExitAction() — Add state exit action.
- addInputAction() — Add input action (defined by {state, input} pair).
- addInputSymbol() — Add symbol to the input alphabet
- addInputSymbols() — Add symbols to the input alphabet
- addRule() — Add symbol to the input alphabet
- addRules() — Add transition rules
- addState() — Add state to the state machine
- addStates() — Add states to the state machine
- addTransitionAction() — Add transition action (defined by {state, input} pair).
- getState() — Get FSM state.
- process() — Process an input
- reset()
- setState() — Set FSM state.