Search/Lucene/Search/QueryLexer.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Search_Lucene  
Subpackage
Search  
Version
$Id: QueryLexer.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_Search_Lucene_Search_QueryLexer

Package: Zend\Search\Lucene\Search
Abstract Finite State Machine

Take a look on Wikipedia state machine description: http://en.wikipedia.org/wiki/Finite_state_machine

Any type of Transducers (Moore machine or Mealy machine) also may be implemented by using this abstract FSM. process() methods invokes a specified actions which may construct FSM output. Actions may be also used to signal, that we have reached Accept State

Parent(s)
\Zend_Search_Lucene_FSM
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  ST_WHITE_SPACE = 0
State Machine states
>VConstant  ST_SYNT_LEXEME = 1
>VConstant  ST_LEXEME = 2
>VConstant  ST_QUOTED_LEXEME = 3
>VConstant  ST_ESCAPED_CHAR = 4
>VConstant  ST_ESCAPED_QCHAR = 5
>VConstant  ST_LEXEME_MODIFIER = 6
>VConstant  ST_NUMBER = 7
>VConstant  ST_MANTISSA = 8
>VConstant  ST_ERROR = 9
>VConstant  IN_WHITE_SPACE = 0
Input symbols
>VConstant  IN_SYNT_CHAR = 1
>VConstant  IN_LEXEME_MODIFIER = 2
>VConstant  IN_ESCAPE_CHAR = 3
>VConstant  IN_QUOTE = 4
>VConstant  IN_DECIMAL_POINT = 5
>VConstant  IN_ASCII_DIGIT = 6
>VConstant  IN_CHAR = 7
>VConstant  IN_MUTABLE_CHAR = 8
>VConstant  QUERY_WHITE_SPACE_CHARS = " \n\r\t"
>VConstant  QUERY_SYNT_CHARS = ':()[]{}!|&'
>VConstant  QUERY_MUTABLE_CHARS = '+-'
>VConstant  QUERY_DOUBLECHARLEXEME_CHARS = '|&'
>VConstant  QUERY_LEXEMEMODIFIER_CHARS = '~^'
>VConstant  QUERY_ASCIIDIGITS_CHARS = '0123456789'

Properties

>VPropertyprivatestring $_currentLexeme
Recognized part of current lexeme
Details
Type
string
>VPropertyprivateinteger|string $_currentState = null
inherited
Current state
Inherited from: \Zend_Search_Lucene_FSM::$$_currentState
Default valuenullDetails
Type
integer | string
Inherited_from
\Zend_Search_Lucene_FSM::$$_currentState  
>VPropertyprivatearray $_entryActions = array()
inherited
List of entry actions Each action executes when entering the state
Inherited from: \Zend_Search_Lucene_FSM::$$_entryActions

[state] => action

Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_FSM::$$_entryActions  
>VPropertyprivatearray $_exitActions = array()
inherited
List of exit actions Each action executes when exiting the state
Inherited from: \Zend_Search_Lucene_FSM::$$_exitActions

[state] => action

Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_FSM::$$_exitActions  
>VPropertyprivatearray $_inputActions = array()
inherited
List of input actions Each action executes when entering the state
Inherited from: \Zend_Search_Lucene_FSM::$$_inputActions

[state][input] => action

Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_FSM::$$_inputActions  
>VPropertyprivatearray $_inputAphabet = array()
inherited
Input alphabet
Inherited from: \Zend_Search_Lucene_FSM::$$_inputAphabet
Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_FSM::$$_inputAphabet  
>VPropertyprivatearray $_lexemes
List of recognized lexemes
Details
Type
array
>VPropertyprivatearray $_queryString
Query string (array of single- or non single-byte characters)
Details
Type
array
>VPropertyprivateinteger $_queryStringPosition
Current position within a query string Used to create appropriate error messages
Details
Type
integer
>VPropertyprivatearray $_rules = array()
inherited
State transition table
Inherited from: \Zend_Search_Lucene_FSM::$$_rules

[sourceState][input] => targetState

Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_FSM::$$_rules  
>VPropertyprivatearray $_states = array()
inherited
Machine States alphabet
Inherited from: \Zend_Search_Lucene_FSM::$$_states
Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_FSM::$$_states  
>VPropertyprivatearray $_transitionActions = array()
inherited
List of input actions Each action executes when entering the state
Inherited from: \Zend_Search_Lucene_FSM::$$_transitionActions

[state1][state2] => action

Default valuearray()Details
Type
array
Inherited_from
\Zend_Search_Lucene_FSM::$$_transitionActions  

Methods

methodpublic__construct() : void

Finite State machine constructor

$states is an array of integers or strings with a list of possible machine states constructor treats fist list element as a sturt state (assignes it to $_current state). It may be reassigned by setState() call. States list may be empty and can be extended later by addState() or addStates() calls.

$inputAphabet is the same as $states, but represents input alphabet it also may be extended later by addInputSymbols() or addInputSymbol() calls.

$rules parameter describes FSM transitions and has a structure: array( array(sourseState, input, targetState[, inputAction]), array(sourseState, input, targetState[, inputAction]), array(sourseState, input, targetState[, inputAction]), ... ) Rules also can be added later by addRules() and addRule() calls.

FSM actions are very flexible and may be defined by addEntryAction(), addExitAction(), addInputAction() and addTransitionAction() calls.

methodprivate_positionMsg() : string

Position message

Returns
TypeDescription
string
methodprivate_translateInput(string $char) : integer

Translate input char to an input symbol of state machine

Parameters
NameTypeDescription
$charstring
Returns
TypeDescription
integer
methodpublicaddEntryAction(integer | string $state, \Zend_Search_Lucene_FSMAction $action) : void
inherited

Add state entry action.

Inherited from: \Zend_Search_Lucene_FSM::addEntryAction()

Several entry actions are allowed. Action execution order is defined by addEntryAction() calls

Parameters
NameTypeDescription
$stateinteger | string
$action\Zend_Search_Lucene_FSMAction
methodpublicaddExitAction(integer | string $state, \Zend_Search_Lucene_FSMAction $action) : void
inherited

Add state exit action.

Inherited from: \Zend_Search_Lucene_FSM::addExitAction()

Several exit actions are allowed. Action execution order is defined by addEntryAction() calls

Parameters
NameTypeDescription
$stateinteger | string
$action\Zend_Search_Lucene_FSMAction
methodpublicaddInputAction(integer | string $state,  $inputSymbol, \Zend_Search_Lucene_FSMAction $action) : void
inherited

Add input action (defined by {state, input} pair).

Inherited from: \Zend_Search_Lucene_FSM::addInputAction()

Several input actions are allowed. Action execution order is defined by addInputAction() calls

Parameters
NameTypeDescription
$stateinteger | string
$inputSymbol
$action\Zend_Search_Lucene_FSMAction
methodpublicaddInputSymbol(integer | string $inputSymbol) : void
inherited

Add symbol to the input alphabet

Inherited from: \Zend_Search_Lucene_FSM::addInputSymbol()
Parameters
NameTypeDescription
$inputSymbolinteger | string
methodpublicaddInputSymbols(array $inputAphabet) : void
inherited

Add symbols to the input alphabet

Inherited from: \Zend_Search_Lucene_FSM::addInputSymbols()
Parameters
NameTypeDescription
$inputAphabetarray
methodpublicaddLexeme() : void

Add lexeme

methodpublicaddLexemeChar() : void

Extend lexeme by one char

methodpublicaddLexemeModifier() : void

Add lexeme modifier

methodpublicaddNumberLexeme() : void

Add number lexeme

methodpublicaddQuerySyntaxLexeme() : void

Add query syntax lexeme

methodpublicaddQuotedLexeme() : void

Add quoted lexeme

methodpublicaddRule(integer | string $sourceState, integer | string $input, integer | string $targetState, \Zend_Search_Lucene_FSMAction | null $inputAction = null) : void
inherited

Add symbol to the input alphabet

Inherited from: \Zend_Search_Lucene_FSM::addRule()
Parameters
NameTypeDescription
$sourceStateinteger | string
$inputinteger | string
$targetStateinteger | string
$inputAction\Zend_Search_Lucene_FSMAction | null
Throws
ExceptionDescription
\Zend_Search_Exception
methodpublicaddRules(array $rules) : void
inherited

Add transition rules

Inherited from: \Zend_Search_Lucene_FSM::addRules()

array structure: array( array(sourseState, input, targetState[, inputAction]), array(sourseState, input, targetState[, inputAction]), array(sourseState, input, targetState[, inputAction]), ... )

Parameters
NameTypeDescription
$rulesarray
methodpublicaddState(integer | string $state) : void
inherited

Add state to the state machine

Inherited from: \Zend_Search_Lucene_FSM::addState()
Parameters
NameTypeDescription
$stateinteger | string
methodpublicaddStates(array $states) : void
inherited

Add states to the state machine

Inherited from: \Zend_Search_Lucene_FSM::addStates()
Parameters
NameTypeDescription
$statesarray
methodpublicaddTransitionAction(integer | string $sourceState, integer | string $targetState, \Zend_Search_Lucene_FSMAction $action) : void
inherited

Add transition action (defined by {state, input} pair).

Inherited from: \Zend_Search_Lucene_FSM::addTransitionAction()

Several transition actions are allowed. Action execution order is defined by addTransitionAction() calls

Parameters
NameTypeDescription
$sourceStateinteger | string
$targetStateinteger | string
$action\Zend_Search_Lucene_FSMAction
methodpublicgetState() : integer | string
inherited

Get FSM state.

Inherited from: \Zend_Search_Lucene_FSM::getState()
Returns
TypeDescription
integer | string$state|null
methodpubliclexModifierErrException() : void

methodpublicprocess(mixed $input) : void
inherited

Process an input

Inherited from: \Zend_Search_Lucene_FSM::process()
Parameters
NameTypeDescription
$inputmixed
Throws
ExceptionDescription
\Zend_Search_Exception
methodpublicquoteWithinLexemeErrException() : void

methodpublicreset() : void
inherited

Inherited from: \Zend_Search_Lucene_FSM::reset()
methodpublicsetState(integer | string $state) : void
inherited

Set FSM state.

Inherited from: \Zend_Search_Lucene_FSM::setState()

No any action is invoked

Parameters
NameTypeDescription
$stateinteger | string
Throws
ExceptionDescription
\Zend_Search_Exception
methodpublictokenize(string $inputString, string $encoding) : array

This method is used to tokenize query string into lexemes

Parameters
NameTypeDescription
$inputStringstring
$encodingstring
Returns
TypeDescription
array
Throws
ExceptionDescription
\Zend_Search_Lucene_Search_QueryParserException
methodpublicwrongNumberErrException() : void

Documentation was generated by phpDocumentor 2.0.0a12.