Class Zend_Search_Lucene_Search_Query_Phrase

Description

A Query that matches documents containing a particular sequence of terms.

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

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

Zend_Search_Lucene_Search_Query
   |
   --Zend_Search_Lucene_Search_Query_Phrase
Method Summary
 Zend_Search_Lucene_Search_Query_Phrase __construct ([array $terms = null], [array $offsets = null], [string $field = null])
 void addTerm (Zend_Search_Lucene_Index_Term $term, [integer $position = null])
 integer getSlop ()
 array getTerms ()
 float score (integer $docId, Zend_Search_Lucene $reader)
 void setSlop (integer $slop)
 void setWeight (integer $num, Zend_Search_Lucene_Search_Weight_Term $weight)
 float _exactPhraseFreq (integer $docId)
 float _sloppyPhraseFreq (integer $docId, Zend_Search_Lucene $reader)
 string __toString ()
Variables
Methods
Constructor __construct (line 107)

Class constructor. Create a new prase query.

  • access: public
  • throws: Zend_Search_Lucene_Exception
Zend_Search_Lucene_Search_Query_Phrase __construct ([array $terms = null], [array $offsets = null], [string $field = null])
  • string $field: Field to search.
  • array $terms: Terms to search Array of strings.
  • array $offsets: Relative term positions. Array of integers.
addTerm (line 169)

Adds a term to the end of the query phrase.

The relative position of the term is specified explicitly or the one immediately after the last term added.

  • access: public
void addTerm (Zend_Search_Lucene_Index_Term $term, [integer $position = null])
createWeight (line 250)

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.
getSlop (line 155)

Get slop

  • access: public
integer getSlop ()
getTerms (line 226)

Returns query term

  • access: public
array getTerms ()
rewrite (line 193)

Re-write queries into primitive queries Also used for query optimization and binding to the index

  • access: public

Redefinition of:
Zend_Search_Lucene_Search_Query::rewrite()
Bind query to the index
score (line 424)

Score specified document

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

Redefinition of:
Zend_Search_Lucene_Search_Query::score()
Score specified document
setSlop (line 144)

Set slop

  • access: public
void setSlop (integer $slop)
  • integer $slop
setWeight (line 238)

Set weight for specified term

  • access: public
void setWeight (integer $num, Zend_Search_Lucene_Search_Weight_Term $weight)
_exactPhraseFreq (line 301)

Score calculator for exact phrase queries (terms sequence is fixed)

  • access: public
float _exactPhraseFreq (integer $docId)
  • integer $docId
_sloppyPhraseFreq (line 347)

Score calculator for sloppy phrase queries (terms sequence is fixed)

  • access: public
float _sloppyPhraseFreq (integer $docId, Zend_Search_Lucene $reader)
__toString (line 463)

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

Documentation generated on Thu, 18 Jan 2007 09:57:55 -0800 by phpDocumentor 1.3.1