Class Zend_Search_Lucene_Search_Query_Wildcard

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

Located in /Search/Lucene/Search/Query/Wildcard.php (line 35) 

Zend_Search_Lucene_Search_Query
   |
   --Zend_Search_Lucene_Search_Query_Wildcard
Method Summary
Description | Vars | Methods (details)
static integer getMinPrefixLength ()
static void setMinPrefixLength (integer $minPrefixLength)
Zend_Search_Lucene_Search_Query_Wildcard __construct (Zend_Search_Lucene_Index_Term $pattern)
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])
Zend_Search_Lucene_Index_Term getPattern ()
array getQueryTerms ()
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 _highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
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)
static getMinPrefixLength (line 82)

Get minimum prefix length

  • access: public
static integer getMinPrefixLength ()
static setMinPrefixLength (line 92)

Set minimum prefix length

  • access: public
static void setMinPrefixLength (integer $minPrefixLength)
  • integer $minPrefixLength
Constructor __construct (line 72)

Zend_Search_Lucene_Search_Query_Wildcard constructor.

  • access: public
Zend_Search_Lucene_Search_Query_Wildcard __construct (Zend_Search_Lucene_Index_Term $pattern)
createWeight (line 262)

Constructs an appropriate Weight implementation for this query.

  • throws: Zend_Search_Lucene_Exception
  • 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 277)

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

  • throws: Zend_Search_Lucene_Exception
  • 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
getPattern (line 233)

Returns query pattern

  • access: public
Zend_Search_Lucene_Index_Term getPattern ()
getQueryTerms (line 245)

Return query terms

  • throws: Zend_Search_Lucene_Exception
  • access: public
array getQueryTerms ()
Redefinition of:
Zend_Search_Lucene_Search_Query::getQueryTerms()
Return query terms
matchedDocs (line 291)

Get document ids likely matching the query

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

  • throws: Zend_Search_Lucene_Exception
  • access: public
array matchedDocs ()
Redefinition of:
Zend_Search_Lucene_Search_Query::matchedDocs()
Get document ids likely matching the query
optimize (line 221)

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

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

  • throws: Zend_Search_Lucene_Exception
  • 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 305)

Score specified document

  • throws: Zend_Search_Lucene_Exception
  • access: public
float score (integer $docId, Zend_Search_Lucene_Interface $reader)
Redefinition of:
Zend_Search_Lucene_Search_Query::score()
Score specified document
_highlightMatches (line 316)

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
__toString (line 344)

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:52:54 -0400 by phpDocumentor 1.4.3