Docs For Class Zend_Search_Lucene_Search_Query

## Class Zend_Search_Lucene_Search_Query

Description

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

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

Direct descendents

Class | Description
--- | ---
Zend_Search_Lucene_Search_Query_MultiTerm |
Zend_Search_Lucene_Search_Query_Phrase | A Query that matches documents containing a particular sequence of terms.
Zend_Search_Lucene_Search_Query_Term |
Zend_Search_Lucene_Search_Query_Boolean |

Variable Summary
Zend_Search_Lucene_Search_Weight $_weight
Method Summary
Zend_Search_Lucene_Search_Weight createWeight (Zend_Search_Lucene $reader)
float getBoost ()
void reset ()
float score (integer $docId, Zend_Search_Lucene $reader)
void setBoost (float $boost)
void _initWeight (Zend_Search_Lucene $reader)
Variables
Zend_Search_Lucene_Search_Weight $_weight = null (line 45)

Query weight

- access: protected

Methods
createWeight (line 85)

Constructs an appropriate Weight implementation for this query.

- access: public
- abstract:

Zend_Search_Lucene_Search_Weight createWeight (Zend_Search_Lucene $reader)

- Zend_Search_Lucene $reader

Redefined in descendants as:

- Zend_Search_Lucene_Search_Query_MultiTerm::createWeight() : Constructs an appropriate Weight implementation for this query.
- Zend_Search_Lucene_Search_Query_Phrase::createWeight() : Constructs an appropriate Weight implementation for this query.
- Zend_Search_Lucene_Search_Query_Term::createWeight() : Constructs an appropriate Weight implementation for this query.
- Zend_Search_Lucene_Search_Query_Boolean::createWeight() : Constructs an appropriate Weight implementation for this query.

getBoost (line 55)

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 ()
reset (line 109)

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

with other indeces

- access: public

void reset ()
score (line 77)

Score specified document

- access: public
- abstract:

float score (integer $docId, Zend_Search_Lucene $reader)

- integer $docId
- Zend_Search_Lucene $reader

Redefined in descendants as:

- Zend_Search_Lucene_Search_Query_MultiTerm::score() : Score specified document
- Zend_Search_Lucene_Search_Query_Phrase::score() : Score specified document
- Zend_Search_Lucene_Search_Query_Term::score() : Score specified document
- Zend_Search_Lucene_Search_Query_Boolean::score() : Score specified document

setBoost (line 65)

Sets the boost for this query clause to $boost.

- access: public

void setBoost (float $boost)

- float $boost

_initWeight (line 92)

Constructs an initializes a Weight for a _top-level_query_.

- access: protected

void _initWeight (Zend_Search_Lucene $reader)

- Zend_Search_Lucene $reader

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