org.languagetool.rules.en
Class AvsAnRule

Object
  Rule
      EnglishRule
          AvsAnRule

public class AvsAnRule
extends EnglishRule

Check if the determiner (if any) preceding a word is:

• an if the next word starts with a vowel
• a if the next word does not start with a vowel

This rule loads some exceptions from external files (e.g. an hour).

Author:

Daniel Naber

Constructor Summary

AvsAnRule(ResourceBundle messages)

Method Summary

String	getDescription()
String	getId() An ASCII-only string used to identify the rule in e.g. configuration files.
RuleMatch[]	match(AnalyzedSentence text) Check whether the given text matches this error rule, i.e. whether the text contains this error.
void	reset() If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset.
String	suggestAorAn(String noun) Adds "a" or "an" to the English noun.

Methods inherited from class Rule

addRuleMatch, clearMatches, getCategory, getCorrectExamples, getIncorrectExamples, getMatches, getMatchesIndex, isDefaultOff, isInMatches, isInRemoved, isParagraphBackTrack, setAsDeleted, setCategory, setCorrectExamples, setDefaultOff, setIncorrectExamples, setParagraphBackTrack, supportsLanguage

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AvsAnRule

public AvsAnRule(ResourceBundle messages)
          throws IOException

Throws:

IOException

Method Detail

getId

public String getId()

Description copied from class: Rule

An ASCII-only string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool.

Specified by:

getId in class Rule

getDescription

public String getDescription()

Specified by:

getDescription in class Rule

match

public RuleMatch[] match(AnalyzedSentence text)

Description copied from class: Rule

Check whether the given text matches this error rule, i.e. whether the text contains this error.

Specified by:

match in class Rule

Parameters:

text - a pre-analyzed sentence

Returns:

an array of RuleMatch object for each match.

suggestAorAn

public final String suggestAorAn(String noun)

Adds "a" or "an" to the English noun. Used for suggesting the proper form of the indefinite article.

Parameters:

noun - Word that needs an article.

Returns:

String containing the word with a determiner, or just the word if the word is an abbreviation.

reset

public void reset()

Description copied from class: Rule

If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset. It will be called before a new text is going to be checked.

Specified by:

reset in class Rule