org.languagetool.rules
Class AbstractCompoundRule

Object
  Rule
      AbstractCompoundRule

Direct Known Subclasses:

CompoundRule, CompoundRule, CompoundRule, CompoundRule, CompoundRule, CompoundRule, RussianCompoundRule

public abstract class AbstractCompoundRule
extends Rule

Checks that compounds (if in the list) are not written as separate words.

Author:

Daniel Naber & Marcin Miłkowski (refactoring)

Constructor Summary

AbstractCompoundRule(ResourceBundle messages, String fileName, String withHyphenMessage, String withoutHyphenMessage, String withOrWithoutHyphenMessage)

Method Summary

abstract String	getDescription()
abstract String	getId() An ASCII-only string used to identify the rule in e.g. configuration files.
int	getMaxUnHyphenatedWordCount()
boolean	isHyphenIgnored()
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.
void	setHyphenIgnored(boolean ignoreHyphen)
void	setMaxUnHyphenatedWordCount(int maxNoHyphensSize)
void	setShort(String shortDescription)

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

AbstractCompoundRule

public AbstractCompoundRule(ResourceBundle messages,
                            String fileName,
                            String withHyphenMessage,
                            String withoutHyphenMessage,
                            String withOrWithoutHyphenMessage)
                     throws IOException

Throws:

IOException

Method Detail

getId

public abstract 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 abstract String getDescription()

Specified by:

getDescription in class Rule

setShort

public void setShort(String shortDescription)

isHyphenIgnored

public boolean isHyphenIgnored()

setHyphenIgnored

public void setHyphenIgnored(boolean ignoreHyphen)

getMaxUnHyphenatedWordCount

public int getMaxUnHyphenatedWordCount()

setMaxUnHyphenatedWordCount

public void setMaxUnHyphenatedWordCount(int maxNoHyphensSize)

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.

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