Abstract Class Zend_Search_Lucene_Search_Query

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

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


	
			
Direct descendents
Variable Summary
Method Summary
 void execute (Zend_Search_Lucene $reader)
 float getBoost ()
 array getQueryTerms ()
 string highlightMatches ($inputHTML $inputHTML)
 void highlightMatchesDOM (Zend_Search_Lucene_Document_Html $doc, integer &$colorIndex)
 array matchedDocs ()
 void reset ()
 float score (integer $docId, Zend_Search_Lucene $reader)
 void setBoost (float $boost)
 string _getHighlightColor (integer &$colorIndex)
 string __toString ()
Variables
Zend_Search_Lucene_Search_Weight $_weight = null (line 48)

Query weight

  • access: protected
Methods
createWeight (line 124)

Constructs an appropriate Weight implementation for this query.

  • access: public
  • abstract:

Redefined in descendants as:
execute (line 116)

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

Query specific implementation

  • access: public
  • abstract:
void execute (Zend_Search_Lucene $reader)

Redefined in descendants as:
getBoost (line 75)

Gets the boost for this clause. Documents matching this clause will (in addition to the normal weightings) have their score multiplied by boost. The boost is 1.0 by default.

  • access: public
float getBoost ()
getQueryTerms (line 182)

Return query terms

  • access: public
  • abstract:
array getQueryTerms ()

Redefined in descendants as:
highlightMatches (line 213)

Highlight matches in $inputHTML

  • access: public
string highlightMatches ($inputHTML $inputHTML)
  • $inputHTML $inputHTML
highlightMatchesDOM (line 205)

Highlight query terms

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

Redefined in descendants as:
matchedDocs (line 106)

Get document ids likely matching the query

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

  • access: public
  • abstract:
array matchedDocs ()

Redefined in descendants as:
optimize (line 158)

Optimize query in the context of specified index

  • access: public
  • abstract:

Redefined in descendants as:
reset (line 164)

Reset query, so it can be reused within other queries or

with other indeces

  • access: public
void reset ()
rewrite (line 150)

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

  • access: public
  • abstract:

Redefined in descendants as:
score (line 97)

Score specified document

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

Redefined in descendants as:
setBoost (line 85)

Sets the boost for this query clause to $boost.

  • access: public
void setBoost (float $boost)
  • float $boost
_getHighlightColor (line 190)

Get highlight color and shift to next

  • access: protected
string _getHighlightColor (integer &$colorIndex)
  • integer &$colorIndex
_initWeight (line 131)

Constructs an initializes a Weight for a _top-level_query_.

  • access: protected
void _initWeight (Zend_Search_Lucene $reader)
__toString (line 175)

Print a query

  • access: public
  • abstract:
string __toString ()

Redefined in descendants as:

Documentation generated on Wed, 21 Feb 2007 11:57:58 -0800 by phpDocumentor 1.3.1