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

   1 package org.apache.lucene.search.spell;
   2
   3
   4 /**
   5  * Licensed to the Apache Software Foundation (ASF) under one or more
   6  * contributor license agreements.  See the NOTICE file distributed with
   7  * this work for additional information regarding copyright ownership.
   8  * The ASF licenses this file to You under the Apache License, Version 2.0
   9  * (the "License"); you may not use this file except in compliance with
  10  * the License.  You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  */
  20
  21 /**
  22  *  SuggestWord, used in suggestSimilar method in SpellChecker class.
  23  * <p/>
  24  * Default sort is first by score, then by frequency.
  25  *
  26  *
  27  */
  28 public final class SuggestWord{
  29
  30   /**
  31    * the score of the word
  32    */
  33   public float score;
  34
  35   /**
  36    * The freq of the word
  37    */
  38   public int freq;
  39
  40   /**
  41    * the suggested word
  42    */
  43   public String string;
  44
  45 }