org.languagetool.rules.en.WordCoherencyRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of language-en Show documentation

There is a newer version: 6.5

/* LanguageTool, a natural language style checker 
 * Copyright (C) 2005 Daniel Naber (http://www.danielnaber.de)
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
 * USA
 */
package org.languagetool.rules.en;

import java.io.IOException;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.Set;

import org.languagetool.rules.AbstractWordCoherencyRule;
import org.languagetool.rules.Example;
import org.languagetool.rules.WordCoherencyDataLoader;

/**
 * English version of {@link AbstractWordCoherencyRule}
 */
public class WordCoherencyRule extends AbstractWordCoherencyRule {

  private static final Map> wordMap = new WordCoherencyDataLoader().loadWords("/en/coherency.txt");

  public WordCoherencyRule(ResourceBundle messages) throws IOException {
    super(messages);
    addExamplePair(Example.wrong("He likes archaeology. Really? She likes archeology, too."),
                   Example.fixed("He likes archaeology. Really? She likes archaeology, too."));
  }

  @Override
  protected Map> getWordMap() {
    return wordMap;
  }

  @Override
  protected String getMessage(String word1, String word2) {
    return "Do not mix variants of the same word ('" + word1 + "' and '" + word2 + "') within a single text.";
  }
  
  @Override
  public String getId() {
    return "EN_WORD_COHERENCY";
  }

  @Override
  public String getDescription() {
    return "Coherent spelling of words with two admitted variants.";
  }

}