Docs For Class Zend_Search_Lucene_Search_Query_MultiTerm

## Class Zend_Search_Lucene_Search_Query_MultiTerm

Description

- license: New BSD License
- copyright: Copyright (c) 2006 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])
Zend_Search_Lucene_Search_Weight createWeight (Zend_Search_Lucene $reader)
array getSigns ()
array getTerms ()
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)
Variables

#### Inherited Variables

Inherited from Zend_Search_Lucene_Search_Query

> Zend_Search_Lucene_Search_Query::$_weight

Methods
Constructor __construct (line 108)

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

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

- Zend_Search_Lucene_Index_Term $term
- boolean|null $sign

createWeight (line 193)

Constructs an appropriate Weight implementation for this query.

- access: public

Zend_Search_Lucene_Search_Weight createWeight (Zend_Search_Lucene $reader)

- Zend_Search_Lucene $reader

Redefinition of:

Zend_Search_Lucene_Search_Query::createWeight()
  Constructs an appropriate Weight implementation for this query.

getSigns (line 169)

Return terms signs

- access: public

array getSigns ()
getTerms (line 158)

Returns query term

- access: public

array getTerms ()
score (line 404)

Score specified document

- access: public

float score (integer $docId, Zend_Search_Lucene $reader)

- integer $docId
- Zend_Search_Lucene $reader

Redefinition of:

Zend_Search_Lucene_Search_Query::score()
  Score specified document

setWeight (line 181)

Set weight for specified term

- access: public

void setWeight (integer $num, Zend_Search_Lucene_Search_Weight_Term $weight)

- integer $num
- Zend_Search_Lucene_Search_Weight_Term $weight

_conjunctionScore (line 336)

Score calculator for conjunction queries (all terms are required)

- access: public

float _conjunctionScore (integer $docId, Zend_Search_Lucene $reader)

- integer $docId
- Zend_Search_Lucene $reader

_nonConjunctionScore (line 362)

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

- access: public

float _nonConjunctionScore (integer $docId, Zend_Search_Lucene $reader)

- integer $docId
- Zend_Search_Lucene $reader

#### 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::reset()
> Zend_Search_Lucene_Search_Query::score()
> Zend_Search_Lucene_Search_Query::setBoost()
> Zend_Search_Lucene_Search_Query::_initWeight()

Documentation generated on Sun, 29 Oct 2006 21:27:24 -0600 by phpDocumentor 1.3.0RC6