summaryrefslogtreecommitdiff
path: root/buildscripts/texbuilder/Zend/Search/Lucene/Search/Weight.php
diff options
context:
space:
mode:
Diffstat (limited to 'buildscripts/texbuilder/Zend/Search/Lucene/Search/Weight.php')
-rw-r--r--buildscripts/texbuilder/Zend/Search/Lucene/Search/Weight.php59
1 files changed, 59 insertions, 0 deletions
diff --git a/buildscripts/texbuilder/Zend/Search/Lucene/Search/Weight.php b/buildscripts/texbuilder/Zend/Search/Lucene/Search/Weight.php
new file mode 100644
index 00000000..2d5b7a72
--- /dev/null
+++ b/buildscripts/texbuilder/Zend/Search/Lucene/Search/Weight.php
@@ -0,0 +1,59 @@
+<?php
+/**
+ * Zend Framework
+ *
+ * LICENSE
+ *
+ * This source file is subject to version 1.0 of the Zend Framework
+ * license, that is bundled with this package in the file LICENSE, and
+ * is available through the world-wide-web at the following URL:
+ * http://www.zend.com/license/framework/1_0.txt. If you did not receive
+ * a copy of the Zend Framework license and are unable to obtain it
+ * through the world-wide-web, please send a note to license@zend.com
+ * so we can mail you a copy immediately.
+ *
+ * @package Zend_Search_Lucene
+ * @subpackage Search
+ * @copyright Copyright (c) 2005-2006 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license http://www.zend.com/license/framework/1_0.txt Zend Framework License version 1.0
+ */
+
+
+/**
+ * Calculate query weights and build query scorers.
+ *
+ * A Weight is constructed by a query Query->createWeight().
+ * The sumOfSquaredWeights() method is then called on the top-level
+ * query to compute the query normalization factor Similarity->queryNorm(float).
+ * This factor is then passed to normalize(float). At this point the weighting
+ * is complete.
+ *
+ * @package Zend_Search_Lucene
+ * @subpackage Search
+ * @copyright Copyright (c) 2005-2006 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license http://www.zend.com/license/framework/1_0.txt Zend Framework License version 1.0
+ */
+abstract class Zend_Search_Lucene_Search_Weight
+{
+ /**
+ * The weight for this query.
+ *
+ * @return float
+ */
+ abstract public function getValue();
+
+ /**
+ * The sum of squared weights of contained query clauses.
+ *
+ * @return float
+ */
+ abstract public function sumOfSquaredWeights();
+
+ /**
+ * Assigns the query normalization factor to this.
+ *
+ * @param $norm
+ */
+ abstract public function normalize($norm);
+}
+