Class Zend_Search_Lucene_Search_Query_Boolean

Description
Description | Vars | Methods (details)
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Search/Lucene/Search/Query/Boolean.php (line 35) 

Zend_Search_Lucene_Search_Query
   |
   --Zend_Search_Lucene_Search_Query_Boolean
Method Summary
Description | Vars | Methods (details)
void __construct ([array $subqueries = null], [array $signs = null])
void addSubquery (Zend_Search_Lucene_Search_Query $subquery, [boolean|null $sign = null])
Zend_Search_Lucene_Search_Weight createWeight (Zend_Search_Lucene_Interface $reader)
void execute (Zend_Search_Lucene_Interface $reader, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
array getQueryTerms ()
array getSigns ()
array getSubqueries ()
array matchedDocs ()
Zend_Search_Lucene_Search_Query optimize (Zend_Search_Lucene_Interface $index)
Zend_Search_Lucene_Search_Query rewrite (Zend_Search_Lucene_Interface $index)
float score (integer $docId, Zend_Search_Lucene_Interface $reader)
float _conjunctionScore (integer $docId, Zend_Search_Lucene_Interface $reader)
void _highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
float _nonConjunctionScore (integer $docId, Zend_Search_Lucene_Interface $reader)
string __toString ()
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from Zend_Search_Lucene_Search_Query

Zend_Search_Lucene_Search_Query::$_weight
Methods
Description | Vars Methods (details)
Constructor __construct (line 86)

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

  • access: public
void __construct ([array $subqueries = null], [array $signs = null])
  • array $subqueries: Array of Zend_Search_Search_Query objects
  • array $signs: Array of signs. Sign is boolean|null.
addSubquery (line 117)

Add a $subquery (Zend_Search_Lucene_Search_Query) to this query.

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

  • access: public
void addSubquery (Zend_Search_Lucene_Search_Query $subquery, [boolean|null $sign = null])
createWeight (line 472)

Constructs an appropriate Weight implementation for this query.

  • access: public
Zend_Search_Lucene_Search_Weight createWeight (Zend_Search_Lucene_Interface $reader)
Redefinition of:
Zend_Search_Lucene_Search_Query::createWeight()
Constructs an appropriate Weight implementation for this query.
execute (line 690)

Execute query in context of index reader It also initializes necessary internal structures

  • access: public
void execute (Zend_Search_Lucene_Interface $reader, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])
Redefinition of:
Zend_Search_Lucene_Search_Query::execute()
Execute query in context of index reader It also initializes necessary internal structures
getQueryTerms (line 756)

Return query terms

  • access: public
array getQueryTerms ()
Redefinition of:
Zend_Search_Lucene_Search_Query::getQueryTerms()
Return query terms
getSigns (line 460)

Return subqueries signs

  • access: public
array getSigns ()
getSubqueries (line 449)

Returns subqueries

  • access: public
array getSubqueries ()
matchedDocs (line 726)

Get document ids likely matching the query

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

  • access: public
array matchedDocs ()
Redefinition of:
Zend_Search_Lucene_Search_Query::matchedDocs()
Get document ids likely matching the query
optimize (line 156)

Optimize query in the context of specified index

  • access: public
Zend_Search_Lucene_Search_Query optimize (Zend_Search_Lucene_Interface $index)
Redefinition of:
Zend_Search_Lucene_Search_Query::optimize()
Optimize query in the context of specified index
rewrite (line 137)

Re-write queries into primitive queries

  • access: public
Zend_Search_Lucene_Search_Query rewrite (Zend_Search_Lucene_Interface $index)
Redefinition of:
Zend_Search_Lucene_Search_Query::rewrite()
Re-write query into primitive queries in the context of specified index
score (line 738)

Score specified document

  • access: public
float score (integer $docId, Zend_Search_Lucene_Interface $reader)
Redefinition of:
Zend_Search_Lucene_Search_Query::score()
Score specified document
_conjunctionScore (line 612)

Score calculator for conjunction queries (all subqueries are required)

  • access: public
float _conjunctionScore (integer $docId, Zend_Search_Lucene_Interface $reader)
_highlightMatches (line 774)

Query specific matches highlighting

  • access: protected
void _highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
Redefinition of:
Zend_Search_Lucene_Search_Query::_highlightMatches()
Query specific matches highlighting
_nonConjunctionScore (line 642)

Score calculator for non conjunction queries (not all subqueries are required)

  • access: public
float _nonConjunctionScore (integer $docId, Zend_Search_Lucene_Interface $reader)
__toString (line 788)

Print a query

  • access: public
string __toString ()
Redefinition of:
Zend_Search_Lucene_Search_Query::__toString()
Print a query

Inherited Methods

Inherited From Zend_Search_Lucene_Search_Query

Zend_Search_Lucene_Search_Query::createWeight()
Zend_Search_Lucene_Search_Query::execute()
Zend_Search_Lucene_Search_Query::getBoost()
Zend_Search_Lucene_Search_Query::getQueryTerms()
Zend_Search_Lucene_Search_Query::highlightMatches()
Zend_Search_Lucene_Search_Query::htmlFragmentHighlightMatches()
Zend_Search_Lucene_Search_Query::matchedDocs()
Zend_Search_Lucene_Search_Query::optimize()
Zend_Search_Lucene_Search_Query::reset()
Zend_Search_Lucene_Search_Query::rewrite()
Zend_Search_Lucene_Search_Query::score()
Zend_Search_Lucene_Search_Query::setBoost()
Zend_Search_Lucene_Search_Query::_highlightMatches()
Zend_Search_Lucene_Search_Query::_initWeight()
Zend_Search_Lucene_Search_Query::__toString()

Documentation generated on Mon, 21 Jun 2010 15:09:29 -0400 by phpDocumentor 1.4.3