Class Zend_Search_Lucene_Search_Query_Phrase

Description
Description | Vars | Methods (details)

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

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

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

Zend_Search_Lucene_Search_Query
   |
   --Zend_Search_Lucene_Search_Query_Phrase
Method Summary
Description | Vars | Methods (details)
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])
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 ()
integer getSlop ()
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 setSlop (integer $slop)
void setWeight (integer $num, Zend_Search_Lucene_Search_Weight_Term $weight)
float _exactPhraseFreq (integer $docId)
void _highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
float _sloppyPhraseFreq (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 99)

Class constructor. Create a new prase query.

  • throws: Zend_Search_Lucene_Exception
  • access: public
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 165)

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

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

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

Return query terms

  • access: public
array getQueryTerms ()
Redefinition of:
Zend_Search_Lucene_Search_Query::getQueryTerms()
Return query terms
getSlop (line 151)

Get slop

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

Returns query term

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

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

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

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

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
setSlop (line 140)

Set slop

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

Set weight for specified term

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

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

  • access: public
float _exactPhraseFreq (integer $docId)
  • integer $docId
_highlightMatches (line 530)

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
_sloppyPhraseFreq (line 342)

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

  • access: public
float _sloppyPhraseFreq (integer $docId, Zend_Search_Lucene_Interface $reader)
__toString (line 545)

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:38:33 -0400 by phpDocumentor 1.4.3