Search/Lucene/Search/BooleanExpressionRecognizer.php

Show:

inherited

Classes
- \Zend_Search_Lucene_Search_BooleanExpressionRecognizer

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Search_Lucene
Subpackage: Search
Version: $Id$

\Zend_Search_Lucene_Search_BooleanExpressionRecognizer
jump to top

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                ST_START
                = 0

State Machine states

 
                ST_LITERAL
                = 1

 
                ST_NOT_OPERATOR
                = 2

 
                ST_AND_OPERATOR
                = 3

 
                ST_OR_OPERATOR
                = 4

 
                IN_LITERAL
                = 0

Input symbols

 
                IN_NOT_OPERATOR
                = 1

 
                IN_AND_OPERATOR
                = 2

 
                IN_OR_OPERATOR
                = 3

Properties

array $_conjunctions = array()

Set of boolean query conjunctions

Each conjunction is an array of conjunction elements Each conjunction element is presented with two-elements array: array(, ) So, it has a structure: array( array( array(, ), // first literal of first conjuction array(, ), // second literal of first conjuction ... array(, ) ), // end of first conjuction array( array(, ), // first literal of second conjuction array(, ), // second literal of second conjuction ... array(, ) ), // end of second conjuction ... ) // end of structure

Default valuearray()Details

Type: array

array $_currentConjunction = array()

Current conjuction

Default valuearray()Details

Type: array

mixed $_literal

Current literal

Details

Type: mixed

boolean $_negativeLiteral = false

NOT operator signal

Default valuefalseDetails

Type: boolean

Methods

__construct() : void

Object constructor

emptyNotOperatorAction() : void

default (omitted) + NOT operator processing

emptyOperatorAction() : void

default (omitted) operator processing

finishExpression() : array

Finish an expression and return result

Result is a set of boolean query conjunctions Each conjunction is an array of conjunction elements Each conjunction element is presented with two-elements array: array(, ) So, it has a structure: array( array( array(, ), // first literal of first conjuction array(, ), // second literal of first conjuction ... array(, ) ), // end of first conjuction array( array(, ), // first literal of second conjuction array(, ), // second literal of second conjuction ... array(, ) ), // end of second conjuction ... ) // end of structure

Returns

Type	Description
array

Throws

Exception	Description
\Zend_Search_Lucene_Exception

literalAction() : void

Literal processing

notOperatorAction() : void

NOT operator processing

orOperatorAction() : void

OR operator processing Close current conjunction

processLiteral( $literal) : void

Process expression literal.

Parameters

Name	Type	Description
$literal

processOperator(integer $operator) : void

Process next operator.

Operators are defined by class constants: IN_AND_OPERATOR, IN_OR_OPERATOR and IN_NOT_OPERATOR