src/Lucene.Net.Suggest/Spell/SuggestWord.cs

namespace Lucene.Net.Search.Spell
{
    /*
     * Licensed to the Apache Software Foundation (ASF) under one or more
     * contributor license agreements.  See the NOTICE file distributed with
     * this work for additional information regarding copyright ownership.
     * The ASF licenses this file to You under the Apache License, Version 2.0
     * (the "License"); you may not use this file except in compliance with
     * the License.  You may obtain a copy of the License at
     *
     *     http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */

    /// <summary>
    /// SuggestWord, used in suggestSimilar method in <see cref="SpellChecker"/> class.
    /// <p/>
    /// Default sort is first by score, then by frequency.
    /// </summary>
    public sealed class SuggestWord
    {

        /// <summary>
        /// Creates a new empty suggestion with null text.
        /// </summary>
        public SuggestWord()
        {
        }

        /// <summary>
        /// the score of the word
        /// </summary>
        public float Score { get; set; }

        /// <summary>
        /// The freq of the word
        /// </summary>
        public int Freq { get; set; }

        /// <summary>
        /// the suggested word
        /// </summary>
        public string String { get; set; }
    }
}