Lucene.Net/Index/TermEnum.cs

   1 namespace Lucene.Net.Index
   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         /// Abstract class for enumerating terms.
  59         /// <p>Term enumerations are always ordered by Term.CompareTo().  Each term in
  60         /// the enumeration is greater than all that precede it. </p>
  61         /// </summary>
  62         public abstract class TermEnum
  63         {
  64                 /// <summary>
  65                 /// Increments the enumeration to the next element.
  66                 /// </summary>
  67                 /// <returns>True if one exists.</returns>
  68                 public abstract bool Next();
  69
  70                 /// <summary>
  71                 /// Returns the current Term in the enumeration.
  72                 /// </summary>
  73                 /// <returns></returns>
  74                 public abstract Term Term();
  75
  76                 /// <summary>
  77                 /// Returns the docFreq of the current Term in the enumeration.
  78                 /// </summary>
  79                 /// <returns></returns>
  80                 public abstract int DocFreq();
  81
  82                 /// <summary>
  83                 /// Closes the enumeration to further activity, freeing resources.
  84                 /// </summary>
  85                 public abstract void Close();
  86         }
  87 }