Docs For Class Zend_Search_Lucene_Search

Zend_Search_Lucene_Search_Query

Description

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

Located in /Search/Lucene/Search/Query.php (line 31)

Direct descendents

Class	Description
Zend_Search_Lucene_Search_Query_MultiTerm
Zend_Search_Lucene_Search_Query_Wildcard
Zend_Search_Lucene_Search_Query_Insignificant	The insignificant query returns empty result, but doesn't limit result set as a part of other queries
Zend_Search_Lucene_Search_Query_Boolean
Zend_Search_Lucene_Search_Query_Phrase	A Query that matches documents containing a particular sequence of terms.
Zend_Search_Lucene_Search_Query_Fuzzy
Zend_Search_Lucene_Search_Query_Preprocessing	It's an internal abstract class intended to finalize ase a query processing after query parsing.
Zend_Search_Lucene_Search_Query_Term
Zend_Search_Lucene_Search_Query_Range
Zend_Search_Lucene_Search_Query_Empty

Variable Summary

Zend_Search_Lucene_Search_Weight $_weight

Method Summary

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

float getBoost ()

array getQueryTerms ()

string highlightMatches (string $inputHTML, [string $defaultEncoding = ''], [Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null])

string htmlFragmentHighlightMatches (string $inputHtmlFragment, [string $encoding = 'UTF-8'], [Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null])

array matchedDocs ()

Zend_Search_Lucene_Search_Query optimize (Zend_Search_Lucene_Interface $index)

void reset ()

Zend_Search_Lucene_Search_Query rewrite (Zend_Search_Lucene_Interface $index)

float score (integer $docId, Zend_Search_Lucene_Interface $reader)

void setBoost (float $boost)

void _highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)

void _initWeight (Zend_Search_Lucene_Interface $reader)

string __toString ()

Variables

Zend_Search_Lucene_Search_Weight $_weight = null (line 45)

Query weight

access: protected

Methods

createWeight (line 111)

Constructs an appropriate Weight implementation for this query.

abstract:
access: public

Zend_Search_Lucene_Search_Weight createWeight (Zend_Search_Lucene_Interface $reader)

Zend_Search_Lucene_Interface $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_Wildcard::createWeight() : Constructs an appropriate Weight implementation for this query.
Zend_Search_Lucene_Search_Query_Insignificant::createWeight() : Constructs an appropriate Weight implementation for this query.
Zend_Search_Lucene_Search_Query_Boolean::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_Fuzzy::createWeight() : Constructs an appropriate Weight implementation for this query.
Zend_Search_Lucene_Search_Query_Preprocessing::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_Range::createWeight() : Constructs an appropriate Weight implementation for this query.
Zend_Search_Lucene_Search_Query_Empty::createWeight() : Constructs an appropriate Weight implementation for this query.

execute (line 103)

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

Query specific implementation

abstract:
access: public

void execute (Zend_Search_Lucene_Interface $reader, [Zend_Search_Lucene_Index_DocsFilter|null $docsFilter = null])

Zend_Search_Lucene_Interface $reader
Zend_Search_Lucene_Index_DocsFilter|null $docsFilter

Redefined in descendants as:

Zend_Search_Lucene_Search_Query_MultiTerm::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Wildcard::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Insignificant::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Boolean::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Phrase::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Fuzzy::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Preprocessing::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Term::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Range::execute() : Execute query in context of index reader It also initializes necessary internal structures
Zend_Search_Lucene_Search_Query_Empty::execute() : Execute query in context of index reader It also initializes necessary internal structures

getBoost (line 61)

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

Return query terms

abstract:
access: public

array getQueryTerms ()

Redefined in descendants as:

Zend_Search_Lucene_Search_Query_MultiTerm::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Wildcard::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Insignificant::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Boolean::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Phrase::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Fuzzy::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Preprocessing::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Term::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Range::getQueryTerms() : Return query terms
Zend_Search_Lucene_Search_Query_Empty::getQueryTerms() : Return query terms

highlightMatches (line 186)

Highlight matches in $inputHTML

access: public

string highlightMatches (string $inputHTML, [string $defaultEncoding = ''], [Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null])

string $inputHTML
string $defaultEncoding: HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter

htmlFragmentHighlightMatches (line 212)

Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)

access: public

string htmlFragmentHighlightMatches (string $inputHtmlFragment, [string $encoding = 'UTF-8'], [Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter = null])

string $inputHtmlFragment
string $encoding: Input HTML string encoding
Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter

matchedDocs (line 92)

Get document ids likely matching the query

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

abstract:
access: public

array matchedDocs ()

Redefined in descendants as:

Zend_Search_Lucene_Search_Query_MultiTerm::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Wildcard::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Insignificant::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Boolean::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Phrase::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Fuzzy::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Preprocessing::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Term::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Range::matchedDocs() : Get document ids likely matching the query
Zend_Search_Lucene_Search_Query_Empty::matchedDocs() : Get document ids likely matching the query

optimize (line 145)

Optimize query in the context of specified index

abstract:
access: public

Zend_Search_Lucene_Search_Query optimize (Zend_Search_Lucene_Interface $index)

Zend_Search_Lucene_Interface $index

Redefined in descendants as:

Zend_Search_Lucene_Search_Query_MultiTerm::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Wildcard::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Insignificant::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Boolean::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Phrase::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Fuzzy::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Preprocessing::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Term::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Range::optimize() : Optimize query in the context of specified index
Zend_Search_Lucene_Search_Query_Empty::optimize() : Optimize query in the context of specified index

reset (line 151)

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

with other indeces

access: public

void reset ()

rewrite (line 137)

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

abstract:
access: public

Zend_Search_Lucene_Search_Query rewrite (Zend_Search_Lucene_Interface $index)

Zend_Search_Lucene_Interface $index

Redefined in descendants as:

Zend_Search_Lucene_Search_Query_MultiTerm::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Wildcard::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Insignificant::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Boolean::rewrite() : Re-write queries into primitive queries
Zend_Search_Lucene_Search_Query_Phrase::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Fuzzy::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Preprocessing_Phrase::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Preprocessing_Fuzzy::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Preprocessing_Term::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Term::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Range::rewrite() : Re-write query into primitive queries in the context of specified index
Zend_Search_Lucene_Search_Query_Empty::rewrite() : Re-write query into primitive queries in the context of specified index

score (line 83)

Score specified document

abstract:
access: public

float score (integer $docId, Zend_Search_Lucene_Interface $reader)

integer $docId
Zend_Search_Lucene_Interface $reader

Redefined in descendants as:

Zend_Search_Lucene_Search_Query_MultiTerm::score() : Score specified document
Zend_Search_Lucene_Search_Query_Wildcard::score() : Score specified document
Zend_Search_Lucene_Search_Query_Insignificant::score() : Score specified document
Zend_Search_Lucene_Search_Query_Boolean::score() : Score specified document
Zend_Search_Lucene_Search_Query_Phrase::score() : Score specified document
Zend_Search_Lucene_Search_Query_Fuzzy::score() : Score specified document
Zend_Search_Lucene_Search_Query_Preprocessing::score() : Score specified document
Zend_Search_Lucene_Search_Query_Term::score() : Score specified document
Zend_Search_Lucene_Search_Query_Range::score() : Score specified document
Zend_Search_Lucene_Search_Query_Empty::score() : Score specified document

setBoost (line 71)

Sets the boost for this query clause to $boost.

access: public

void setBoost (float $boost)

float $boost

_highlightMatches (line 176)

Query specific matches highlighting

abstract:
access: protected

void _highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)

Zend_Search_Lucene_Search_Highlighter_Interface $highlighter: Highlighter object (also contains doc for highlighting)

Redefined in descendants as:

Zend_Search_Lucene_Search_Query_MultiTerm::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Wildcard::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Insignificant::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Boolean::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Phrase::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Fuzzy::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Preprocessing_Phrase::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Preprocessing_Fuzzy::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Preprocessing_Term::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Term::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Range::_highlightMatches() : Query specific matches highlighting
Zend_Search_Lucene_Search_Query_Empty::_highlightMatches() : Query specific matches highlighting

_initWeight (line 118)

Constructs an initializes a Weight for a _top-level_query_.

access: protected

void _initWeight (Zend_Search_Lucene_Interface $reader)

Zend_Search_Lucene_Interface $reader

__toString (line 162)

Print a query

abstract:
access: public

string __toString ()

Redefined in descendants as:

Zend_Search_Lucene_Search_Query_MultiTerm::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Wildcard::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Insignificant::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Boolean::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Phrase::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Fuzzy::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Preprocessing_Phrase::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Preprocessing_Fuzzy::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Preprocessing_Term::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Term::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Range::__toString() : Print a query
Zend_Search_Lucene_Search_Query_Empty::__toString() : Print a query

Documentation generated on Mon, 21 Jun 2010 15:40:30 -0400 by phpDocumentor 1.4.3