Zend Framework  1.12
Public Member Functions | Protected Member Functions | List of all members
Zend_Search_Lucene_Search_Query_Empty Class Reference

Public Member Functions

 rewrite (Zend_Search_Lucene_Interface $index)
 Re-write query into primitive queries in the context of specified index.
 
 optimize (Zend_Search_Lucene_Interface $index)
 Optimize query in the context of specified index.
 
 createWeight (Zend_Search_Lucene_Interface $reader)
 Constructs an appropriate Weight implementation for this query.
 
 execute (Zend_Search_Lucene_Interface $reader, $docsFilter=null)
 Execute query in context of index reader It also initializes necessary internal structures.
 
 matchedDocs ()
 Get document ids likely matching the query.
 
 score ($docId, Zend_Search_Lucene_Interface $reader)
 Score specified document.
 
 getQueryTerms ()
 Return query terms.
 
 __toString ()
 Print a query.
 
- Public Member Functions inherited from Zend_Search_Lucene_Search_Query
 getBoost ()
 Gets the boost for this clause.
 
 setBoost ($boost)
 Sets the boost for this query clause to $boost.
 
 score ($docId, Zend_Search_Lucene_Interface $reader)
 Score specified document.
 
 matchedDocs ()
 Get document ids likely matching the query.
 
 execute (Zend_Search_Lucene_Interface $reader, $docsFilter=null)
 Execute query in context of index reader It also initializes necessary internal structures.
 
 createWeight (Zend_Search_Lucene_Interface $reader)
 Constructs an appropriate Weight implementation for this query.
 
 rewrite (Zend_Search_Lucene_Interface $index)
 Re-write query into primitive queries in the context of specified index.
 
 optimize (Zend_Search_Lucene_Interface $index)
 Optimize query in the context of specified index.
 
 reset ()
 Reset query, so it can be reused within other queries or with other indeces.
 
 __toString ()
 Print a query.
 
 getQueryTerms ()
 Return query terms.
 
 highlightMatches ($inputHTML, $defaultEncoding= '', $highlighter=null)
 Highlight matches in $inputHTML.
 
 htmlFragmentHighlightMatches ($inputHtmlFragment, $encoding= 'UTF-8', $highlighter=null)
 Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)
 

Protected Member Functions

 _highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
 Query specific matches highlighting.
 
- Protected Member Functions inherited from Zend_Search_Lucene_Search_Query
 _initWeight (Zend_Search_Lucene_Interface $reader)
 Constructs an initializes a Weight for a _top-level_query_.
 
 _highlightMatches (Zend_Search_Lucene_Search_Highlighter_Interface $highlighter)
 Query specific matches highlighting.
 

Additional Inherited Members

- Protected Attributes inherited from Zend_Search_Lucene_Search_Query
 $_weight = null
 

Member Function Documentation

__toString ( )

Print a query.

Returns
string
_highlightMatches ( Zend_Search_Lucene_Search_Highlighter_Interface  $highlighter)
protected

Query specific matches highlighting.

Parameters
Zend_Search_Lucene_Search_Highlighter_Interface$highlighterHighlighter object (also contains doc for highlighting)
createWeight ( Zend_Search_Lucene_Interface  $reader)

Constructs an appropriate Weight implementation for this query.

Parameters
Zend_Search_Lucene_Interface$reader
Returns
Zend_Search_Lucene_Search_Weight
execute ( Zend_Search_Lucene_Interface  $reader,
  $docsFilter = null 
)

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

Parameters
Zend_Search_Lucene_Interface$reader
Zend_Search_Lucene_Index_DocsFilter | null$docsFilter
getQueryTerms ( )

Return query terms.

Returns
array
matchedDocs ( )

Get document ids likely matching the query.

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

Returns
array
optimize ( Zend_Search_Lucene_Interface  $index)

Optimize query in the context of specified index.

Parameters
Zend_Search_Lucene_Interface$index
Returns
Zend_Search_Lucene_Search_Query
rewrite ( Zend_Search_Lucene_Interface  $index)

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

Parameters
Zend_Search_Lucene_Interface$index
Returns
Zend_Search_Lucene_Search_Query
score (   $docId,
Zend_Search_Lucene_Interface  $reader 
)

Score specified document.

Parameters
integer$docId
Zend_Search_Lucene_Interface$reader
Returns
float