\Zend_Search_Lucene_Search_Query
- Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- License: http://framework.zend.com/license/new-bsd New BSD License
Synopsis
class Zend_Search_Lucene_Search_Query
{
- // members
- private integer $_boost = 1;
- protected Zend_Search_Lucene_Search_Weight $_weight = NULL;
- private integer $_currentColorIndex = 0;
- // methods
- public float getBoost()
- public void setBoost()
- public abstract float score()
- public abstract array matchedDocs()
- public abstract void execute()
- public abstract Zend_Search_Lucene_Search_Weight createWeight()
- protected void _initWeight()
- public abstract Zend_Search_Lucene_Search_Query rewrite()
- public abstract Zend_Search_Lucene_Search_Query optimize()
- public void reset()
- public abstract string __toString()
- public abstract array getQueryTerms()
- protected abstract void _highlightMatches()
- public string highlightMatches()
- public string htmlFragmentHighlightMatches()
Members
private
- $_boost
—
float
query boost factor - $_currentColorIndex
—
integer
Current highlight color
protected
- $_weight
—
Zend_Search_Lucene_Search_Weight
Query weight
Methods
protected
- _highlightMatches() — Query specific matches highlighting
- _initWeight() — Constructs an initializes a Weight for a _top-level_query_.
public
- __toString() — Print a query
- createWeight() — Constructs an appropriate Weight implementation for this query.
- execute() — Execute query in context of index reader It also initializes necessary internal structures
- getBoost() — 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.
- getQueryTerms() — Return query terms
- highlightMatches() — Highlight matches in $inputHTML
- htmlFragmentHighlightMatches() — Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)
- matchedDocs() — Get document ids likely matching the query
- optimize() — Optimize query in the context of specified index
- reset() — Reset query, so it can be reused within other queries or with other indeces
- rewrite() — Re-write query into primitive queries in the context of specified index
- score() — Score specified document
- setBoost() — Sets the boost for this query clause to $boost.