Lucene.Net/Search/Scorer.cs

   1 namespace Lucene.Net.Search
   2 {
   3         /* ====================================================================
   4          * The Apache Software License, Version 1.1
   5          *
   6          * Copyright (c) 2001 The Apache Software Foundation.  All rights
   7          * reserved.
   8          *
   9          * Redistribution and use in source and binary forms, with or without
  10          * modification, are permitted provided that the following conditions
  11          * are met:
  12          *
  13          * 1. Redistributions of source code must retain the above copyright
  14          *    notice, this list of conditions and the following disclaimer.
  15          *
  16          * 2. Redistributions in binary form must reproduce the above copyright
  17          *    notice, this list of conditions and the following disclaimer in
  18          *    the documentation and/or other materials provided with the
  19          *    distribution.
  20          *
  21          * 3. The end-user documentation included with the redistribution,
  22          *    if any, must include the following acknowledgment:
  23          *       "This product includes software developed by the
  24          *        Apache Software Foundation (http://www.apache.org/)."
  25          *    Alternately, this acknowledgment may appear in the software itself,
  26          *    if and wherever such third-party acknowledgments normally appear.
  27          *
  28          * 4. The names "Apache" and "Apache Software Foundation" and
  29          *    "Apache Lucene" must not be used to endorse or promote products
  30          *    derived from this software without prior written permission. For
  31          *    written permission, please contact apache@apache.org.
  32          *
  33          * 5. Products derived from this software may not be called "Apache",
  34          *    "Apache Lucene", nor may "Apache" appear in their name, without
  35          *    prior written permission of the Apache Software Foundation.
  36          *
  37          * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  38          * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  39          * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  40          * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  41          * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  42          * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  43          * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  44          * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45          * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  46          * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  47          * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  48          * SUCH DAMAGE.
  49          * ====================================================================
  50          *
  51          * This software consists of voluntary contributions made by many
  52          * individuals on behalf of the Apache Software Foundation.  For more
  53          * information on the Apache Software Foundation, please see
  54          * <http://www.apache.org/>.
  55          */
  56
  57         /// <summary>
  58         /// Expert: Implements scoring for a class of queries.
  59         /// </summary>
  60         public abstract class Scorer
  61         {
  62                 private Similarity similarity;
  63
  64                 /// <summary>
  65                 /// Constructs a Scorer.
  66                 /// </summary>
  67                 /// <param name="similarity"></param>
  68                 protected Scorer(Similarity similarity)
  69                 {
  70                         this.similarity = similarity;
  71                 }
  72
  73                 /// <summary>
  74                 /// Returns the Similarity implementation used by this scorer.
  75                 /// </summary>
  76                 /// <returns></returns>
  77                 public Similarity GetSimilarity()
  78                 {
  79                         return this.similarity;
  80                 }
  81
  82                 /// <summary>
  83                 /// Scores hits and passes them to a collector.  Stops at the last document
  84                 /// before <code>maxDoc</code>.  If called repeatedly, will restart at point
  85                 /// where it last left off.
  86                 /// </summary>
  87                 /// <param name="hc"></param>
  88                 /// <param name="maxDoc"></param>
  89                 public abstract void Score(HitCollector hc, int maxDoc) ;
  90
  91                 /// <summary>
  92                 /// Returns an explanation of the score for <code>doc</code>.
  93                 /// </summary>
  94                 /// <param name="doc"></param>
  95                 /// <returns></returns>
  96                 public abstract Explanation Explain(int doc) ;
  97         }
  98 }