[ Index ]

PHP Cross Reference of Moodle 1.9.3 [Build 15-Oct-2008]

title

Body

[close]

/search/Zend/Search/Lucene/Search/Query/ -> Boolean.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
File Size: 715 lines (23 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Zend_Search_Lucene_Search_Query_Boolean:: (17 methods):
  __construct()
  addSubquery()
  rewrite()
  optimize()
  getSubqueries()
  getSigns()
  createWeight()
  _calculateConjunctionResult()
  _calculateNonConjunctionResult()
  _conjunctionScore()
  _nonConjunctionScore()
  execute()
  matchedDocs()
  score()
  getQueryTerms()
  highlightMatchesDOM()
  __toString()


Class: Zend_Search_Lucene_Search_Query_Boolean  - X-Ref


__construct($subqueries = null, $signs = null)   X-Ref
Class constructor.  Create a new Boolean query object.

if $signs array is omitted then all subqueries are required
it differs from addSubquery() behavior, but should never be used

param: array $subqueries    Array of Zend_Search_Search_Query objects
param: array $signs    Array of signs.  Sign is boolean|null.
return: void

addSubquery(Zend_Search_Lucene_Search_Query $subquery, $sign=null)   X-Ref
Add a $subquery (Zend_Search_Lucene_Query) to this query.

The sign is specified as:
TRUE  - subquery is required
FALSE - subquery is prohibited
NULL  - subquery is neither prohibited, nor required

param: Zend_Search_Lucene_Search_Query $subquery
param: boolean|null $sign
return: void

rewrite(Zend_Search_Lucene_Interface $index)   X-Ref
Re-write queries into primitive queries

param: Zend_Search_Lucene_Interface $index
return: Zend_Search_Lucene_Search_Query

optimize(Zend_Search_Lucene_Interface $index)   X-Ref
Optimize query in the context of specified index

param: Zend_Search_Lucene_Interface $index
return: Zend_Search_Lucene_Search_Query

getSubqueries()   X-Ref
Returns subqueries

return: array

getSigns()   X-Ref
Return subqueries signs

return: array

createWeight(Zend_Search_Lucene_Interface $reader)   X-Ref
Constructs an appropriate Weight implementation for this query.

param: Zend_Search_Lucene_Interface $reader
return: Zend_Search_Lucene_Search_Weight

_calculateConjunctionResult()   X-Ref
Calculate result vector for Conjunction query
(like '<subquery1> AND <subquery2> AND <subquery3>')


_calculateNonConjunctionResult()   X-Ref
Calculate result vector for non Conjunction query
(like '<subquery1> AND <subquery2> AND NOT <subquery3> OR <subquery4>')


_conjunctionScore($docId, Zend_Search_Lucene_Interface $reader)   X-Ref
Score calculator for conjunction queries (all subqueries are required)

param: integer $docId
param: Zend_Search_Lucene_Interface $reader
return: float

_nonConjunctionScore($docId, Zend_Search_Lucene_Interface $reader)   X-Ref
Score calculator for non conjunction queries (not all subqueries are required)

param: integer $docId
param: Zend_Search_Lucene_Interface $reader
return: float

execute(Zend_Search_Lucene_Interface $reader)   X-Ref
Execute query in context of index reader
It also initializes necessary internal structures

param: Zend_Search_Lucene_Interface $reader

matchedDocs()   X-Ref
Get document ids likely matching the query

It's an array with document ids as keys (performance considerations)

return: array

score($docId, Zend_Search_Lucene_Interface $reader)   X-Ref
Score specified document

param: integer $docId
param: Zend_Search_Lucene_Interface $reader
return: float

getQueryTerms()   X-Ref
Return query terms

return: array

highlightMatchesDOM(Zend_Search_Lucene_Document_Html $doc, &$colorIndex)   X-Ref
Highlight query terms

param: integer &$colorIndex
param: Zend_Search_Lucene_Document_Html $doc

__toString()   X-Ref
Print a query

return: string



Generated: Wed Jan 14 11:33:29 2009 Cross-referenced by PHPXref 0.7