lucene-java-3.5.0/lucene/contrib/spellchecker/src/java/org/apache/lucene/search/spell/SuggestMode.java

   1 package org.apache.lucene.search.spell;
   2
   3 /**
   4  * Licensed to the Apache Software Foundation (ASF) under one or more
   5  * contributor license agreements.  See the NOTICE file distributed with
   6  * this work for additional information regarding copyright ownership.
   7  * The ASF licenses this file to You under the Apache License, Version 2.0
   8  * (the "License"); you may not use this file except in compliance with
   9  * the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 /**
  21  * Set of strategies for suggesting related terms
  22  * @lucene.experimental
  23  */
  24 public enum SuggestMode {
  25   /**
  26    * Generate suggestions only for terms not in the index (default)
  27    */
  28   SUGGEST_WHEN_NOT_IN_INDEX,
  29
  30   /**
  31    * Return only suggested words that are as frequent or more frequent than the
  32    * searched word
  33    */
  34   SUGGEST_MORE_POPULAR,
  35
  36   /**
  37    * Always attempt to offer suggestions (however, other parameters may limit
  38    * suggestions.)
  39    */
  40   SUGGEST_ALWAYS
  41 }