Class Zend_Search_Lucene_Search_Query_MultiTerm

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/MultiTerm.php (line 35) 

Zend_Search_Lucene_Search_Query
   |
   --Zend_Search_Lucene_Search_Query_MultiTerm
Method Summary
Description | Vars | Methods (details)
Zend_Search_Lucene_Search_Query_MultiTerm __construct ([array $terms = null], [array $signs = null])
void addTerm (Zend_Search_Lucene_Index_Term $term, [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 getTerms ()
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)
void setWeight (integer $num, Zend_Search_Lucene_Search_Weight_Term $weight)
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 106)

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

  • throws: Zend_Search_Lucene_Exception
  • access: public
Zend_Search_Lucene_Search_Query_MultiTerm __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 142)

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

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

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

Return query terms

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

Return terms signs

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

Returns query term

  • access: public
array getTerms ()
matchedDocs (line 562)

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

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

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

  • 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 574)

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
setWeight (line 297)

Set weight for specified term

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

Score calculator for conjunction queries (all terms are required)

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

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

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

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

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:34:42 -0400 by phpDocumentor 1.4.3