Zend_Search_Lucene_Search_Query_Range Class Reference

Public Member Functions
	__construct ($lowerTerm, $upperTerm, $inclusive)
	Zend_Search_Lucene_Search_Query_Range constructor.
	getField ()
	Get query field name.
	getLowerTerm ()
	Get lower term.
	getUpperTerm ()
	Get upper term.
	isInclusive ()
	Get upper term.
	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.
	getQueryTerms ()
	Return query terms.
	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.
	__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

Constructor & Destructor Documentation

__construct	(		$lowerTerm,
			$upperTerm,
			$inclusive
	)

Zend_Search_Lucene_Search_Query_Range constructor.

Parameters

Zend_Search_Lucene_Index_Term | null	$lowerTerm
Zend_Search_Lucene_Index_Term | null	$upperTerm
boolean	$inclusive

Exceptions

Zend_Search_Lucene_Exception

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

$highlighter

Highlighter 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

Exceptions

Zend_Search_Lucene_Exception

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

Exceptions

Zend_Search_Lucene_Exception

getField

(

)

Get query field name.

Returns

string|null

getLowerTerm

(

)

Get lower term.

Returns

Zend_Search_Lucene_Index_Term|null

getQueryTerms

(

)

Return query terms.

Returns

array

Exceptions

Zend_Search_Lucene_Exception

getUpperTerm

(

)

Get upper term.

Returns

Zend_Search_Lucene_Index_Term|null

isInclusive

(

)

Get upper term.

Returns

boolean

matchedDocs

(

)

Get document ids likely matching the query.

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

Returns

array

Exceptions

Zend_Search_Lucene_Exception

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

Exceptions

Zend_Search_Lucene_Exception