/* 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 de.danielnaber.languagetool.rules.pl;

import java.io.IOException;
import java.util.Locale;
import java.util.ResourceBundle;

import de.danielnaber.languagetool.rules.AbstractSimpleReplaceRule;

/**
 * A rule that matches words or phrases which should not be used and suggests
 * correct ones instead.
 * 
 * Polish implementations. Loads the list of words from
 * <code>rules/pl/replace.txt</code>.
 * 
 * @author Marcin Miłkowski
 */
public class SimpleReplaceRule extends AbstractSimpleReplaceRule {

	public static final String POLISH_SIMPLE_REPLACE_RULE = "PL_SIMPLE_REPLACE";
	
	private static final String FILE_NAME = "/pl/replace.txt";
	// locale used on case-conversion
	private static final Locale PL_LOCALE = new Locale("pl");

	public final String getFileName() {
		return FILE_NAME;
	}

	public SimpleReplaceRule(final ResourceBundle messages) throws IOException {
		super(messages);
	}

	public final String getId() {
		return POLISH_SIMPLE_REPLACE_RULE;
	}

	public String getDescription() {
		return "Typowe literówki";
	}
	
	public String getShort() {
	  return "Literówka";
	}
	
	public String getSuggestion() {
	  return " to typowa literówka, poprawnie: ";
	}
	
	/**
	 * use case-insensitive matching.
	 */
	public boolean isCaseSensitive() {
		return false;
	}

	/**
	 * locale used on case-conversion
	 */
	public Locale getLocale() {
		return PL_LOCALE;
	}

}