Class Zend_Search_Lucene_Search_Query_MultiTerm

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

Located in /Zend/Search/Lucene/Search/Query/MultiTerm.php (line 37)

Zend_Search_Lucene_Search_Query
   |
   --Zend_Search_Lucene_Search_Query_MultiTerm
Method Summary
 void __construct ([array $terms = null], [array $signs = null])
 void addTerm (Zend_Search_Lucene_Index_Term $term, [boolean|null $sign = null])
 void execute (Zend_Search_Lucene $reader)
 array getQueryTerms ()
 array getSigns ()
 array getTerms ()
 void highlightMatchesDOM (Zend_Search_Lucene_Document_Html $doc, integer &$colorIndex)
 array matchedDocs ()
 float score (integer $docId, Zend_Search_Lucene $reader)
 void setWeight (integer $num, Zend_Search_Lucene_Search_Weight_Term $weight)
 float _conjunctionScore (integer $docId, Zend_Search_Lucene $reader)
 float _nonConjunctionScore (integer $docId, Zend_Search_Lucene $reader)
 string __toString ()
Variables
Methods
Constructor __construct (line 108)

Class constructor. Create a new multi-term query object.

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

  • access: public
void __construct ([array $terms = null], [array $signs = null])
  • array $terms: Array of Zend_Search_Lucene_Index_Term objects
  • array $signs: Array of signs. Sign is boolean|null.
addTerm (line 139)

Add a $term (Zend_Search_Lucene_Index_Term) to this query.

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

  • access: public
void addTerm (Zend_Search_Lucene_Index_Term $term, [boolean|null $sign = null])
createWeight (line 298)

Constructs an appropriate Weight implementation for this query.

  • access: public

Redefinition of:
Zend_Search_Lucene_Search_Query::createWeight()
Constructs an appropriate Weight implementation for this query.
execute (line 458)

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

  • access: public
void execute (Zend_Search_Lucene $reader)

Redefinition of:
Zend_Search_Lucene_Search_Query::execute()
Execute query in context of index reader It also initializes necessary internal structures
getQueryTerms (line 507)

Return query terms

  • access: public
array getQueryTerms ()

Redefinition of:
Zend_Search_Lucene_Search_Query::getQueryTerms()
Return query terms
getSigns (line 274)

Return terms signs

  • access: public
array getSigns ()
getTerms (line 263)

Returns query term

  • access: public
array getTerms ()
highlightMatchesDOM (line 530)

Highlight query terms

  • access: public
void highlightMatchesDOM (Zend_Search_Lucene_Document_Html $doc, integer &$colorIndex)

Redefinition of:
Zend_Search_Lucene_Search_Query::highlightMatchesDOM()
Highlight query terms
matchedDocs (line 477)

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 198)

Optimize query in the context of specified index

  • access: public

Redefinition of:
Zend_Search_Lucene_Search_Query::optimize()
Optimize query in the context of specified index
rewrite (line 159)

Re-write query into primitive queries in the context of specified index

  • access: public

Redefinition of:
Zend_Search_Lucene_Search_Query::rewrite()
Re-write query into primitive queries in the context of specified index
score (line 489)

Score specified document

  • access: public
float score (integer $docId, Zend_Search_Lucene $reader)

Redefinition of:
Zend_Search_Lucene_Search_Query::score()
Score specified document
setWeight (line 286)

Set weight for specified term

  • access: public
void setWeight (integer $num, Zend_Search_Lucene_Search_Weight_Term $weight)
_conjunctionScore (line 391)

Score calculator for conjunction queries (all terms are required)

  • access: public
float _conjunctionScore (integer $docId, Zend_Search_Lucene $reader)
_nonConjunctionScore (line 417)

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

  • access: public
float _nonConjunctionScore (integer $docId, Zend_Search_Lucene $reader)
__toString (line 554)

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::highlightMatchesDOM()
 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::_getHighlightColor()
 Zend_Search_Lucene_Search_Query::_initWeight()
 Zend_Search_Lucene_Search_Query::__toString()

Documentation generated on Wed, 21 Feb 2007 11:54:41 -0800 by phpDocumentor 1.3.1