--- /dev/null
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to the new BSD license that is bundled
+ * with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * http://framework.zend.com/license/new-bsd
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@zend.com so we can send you a copy immediately.
+ *
+ * @category Zend
+ * @package Zend_Search_Lucene
+ * @subpackage Search
+ * @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license http://framework.zend.com/license/new-bsd New BSD License
+ * @version $Id: Query.php 16541 2009-07-07 06:59:03Z bkarwin $
+ */
+
+/** Zend_Search_Lucene_Document_Html */
+require_once 'Zend/Search/Lucene/Document/Html.php';
+
+/** Zend_Search_Lucene_Index_DocsFilter */
+require_once 'Zend/Search/Lucene/Index/DocsFilter.php';
+
+/** Zend_Search_Lucene_Search_Highlighter_Default */
+require_once 'Zend/Search/Lucene/Search/Highlighter/Default.php';
+
+
+/**
+ * @category Zend
+ * @package Zend_Search_Lucene
+ * @subpackage Search
+ * @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license http://framework.zend.com/license/new-bsd New BSD License
+ */
+abstract class Zend_Search_Lucene_Search_Query
+{
+ /**
+ * query boost factor
+ *
+ * @var float
+ */
+ private $_boost = 1;
+
+ /**
+ * Query weight
+ *
+ * @var Zend_Search_Lucene_Search_Weight
+ */
+ protected $_weight = null;
+
+ /**
+ * Current highlight color
+ *
+ * @var integer
+ */
+ private $_currentColorIndex = 0;
+
+ /**
+ * 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.
+ *
+ * @return float
+ */
+ public function getBoost()
+ {
+ return $this->_boost;
+ }
+
+ /**
+ * Sets the boost for this query clause to $boost.
+ *
+ * @param float $boost
+ */
+ public function setBoost($boost)
+ {
+ $this->_boost = $boost;
+ }
+
+ /**
+ * Score specified document
+ *
+ * @param integer $docId
+ * @param Zend_Search_Lucene_Interface $reader
+ * @return float
+ */
+ abstract public function score($docId, Zend_Search_Lucene_Interface $reader);
+
+ /**
+ * Get document ids likely matching the query
+ *
+ * It's an array with document ids as keys (performance considerations)
+ *
+ * @return array
+ */
+ abstract public function matchedDocs();
+
+ /**
+ * Execute query in context of index reader
+ * It also initializes necessary internal structures
+ *
+ * Query specific implementation
+ *
+ * @param Zend_Search_Lucene_Interface $reader
+ * @param Zend_Search_Lucene_Index_DocsFilter|null $docsFilter
+ */
+ abstract public function execute(Zend_Search_Lucene_Interface $reader, $docsFilter = null);
+
+ /**
+ * Constructs an appropriate Weight implementation for this query.
+ *
+ * @param Zend_Search_Lucene_Interface $reader
+ * @return Zend_Search_Lucene_Search_Weight
+ */
+ abstract public function createWeight(Zend_Search_Lucene_Interface $reader);
+
+ /**
+ * Constructs an initializes a Weight for a _top-level_query_.
+ *
+ * @param Zend_Search_Lucene_Interface $reader
+ */
+ protected function _initWeight(Zend_Search_Lucene_Interface $reader)
+ {
+ // Check, that it's a top-level query and query weight is not initialized yet.
+ if ($this->_weight !== null) {
+ return $this->_weight;
+ }
+
+ $this->createWeight($reader);
+ $sum = $this->_weight->sumOfSquaredWeights();
+ $queryNorm = $reader->getSimilarity()->queryNorm($sum);
+ $this->_weight->normalize($queryNorm);
+ }
+
+ /**
+ * Re-write query into primitive queries in the context of specified index
+ *
+ * @param Zend_Search_Lucene_Interface $index
+ * @return Zend_Search_Lucene_Search_Query
+ */
+ abstract public function rewrite(Zend_Search_Lucene_Interface $index);
+
+ /**
+ * Optimize query in the context of specified index
+ *
+ * @param Zend_Search_Lucene_Interface $index
+ * @return Zend_Search_Lucene_Search_Query
+ */
+ abstract public function optimize(Zend_Search_Lucene_Interface $index);
+
+ /**
+ * Reset query, so it can be reused within other queries or
+ * with other indeces
+ */
+ public function reset()
+ {
+ $this->_weight = null;
+ }
+
+
+ /**
+ * Print a query
+ *
+ * @return string
+ */
+ abstract public function __toString();
+
+ /**
+ * Return query terms
+ *
+ * @return array
+ */
+ abstract public function getQueryTerms();
+
+ /**
+ * Query specific matches highlighting
+ *
+ * @param Zend_Search_Lucene_Search_Highlighter_Interface $highlighter Highlighter object (also contains doc for highlighting)
+ */
+ abstract protected function _highlightMatches(Zend_Search_Lucene_Search_Highlighter_Interface $highlighter);
+
+ /**
+ * Highlight matches in $inputHTML
+ *
+ * @param string $inputHTML
+ * @param string $defaultEncoding HTML encoding, is used if it's not specified using Content-type HTTP-EQUIV meta tag.
+ * @param Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter
+ * @return string
+ */
+ public function highlightMatches($inputHTML, $defaultEncoding = '', $highlighter = null)
+ {
+ if ($highlighter === null) {
+ $highlighter = new Zend_Search_Lucene_Search_Highlighter_Default();
+ }
+
+ $doc = Zend_Search_Lucene_Document_Html::loadHTML($inputHTML, false, $defaultEncoding);
+ $highlighter->setDocument($doc);
+
+ $this->_highlightMatches($highlighter);
+
+ return $doc->getHTML();
+ }
+
+ /**
+ * Highlight matches in $inputHtmlFragment and return it (without HTML header and body tag)
+ *
+ * @param string $inputHtmlFragment
+ * @param string $encoding Input HTML string encoding
+ * @param Zend_Search_Lucene_Search_Highlighter_Interface|null $highlighter
+ * @return string
+ */
+ public function htmlFragmentHighlightMatches($inputHtmlFragment, $encoding = 'UTF-8', $highlighter = null)
+ {
+ if ($highlighter === null) {
+ $highlighter = new Zend_Search_Lucene_Search_Highlighter_Default();
+ }
+
+ $inputHTML = '<html><head><META HTTP-EQUIV="Content-type" CONTENT="text/html; charset=UTF-8"/></head><body>'
+ . iconv($encoding, 'UTF-8//IGNORE', $inputHtmlFragment) . '</body></html>';
+
+ $doc = Zend_Search_Lucene_Document_Html::loadHTML($inputHTML);
+ $highlighter->setDocument($doc);
+
+ $this->_highlightMatches($highlighter);
+
+ return $doc->getHtmlBody();
+ }
+}
+
projects / web.mtrack / blobdiff