org.languagetool.rules.patterns

Class AbstractPatternRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.patterns.AbstractPatternRule

Direct Known Subclasses:

DisambiguationPatternRule, PatternRule

public abstract class AbstractPatternRule
extends Rule

An Abstract Pattern Rule that describes a pattern of words or part-of-speech tags used for PatternRule and DisambiguationPatternRule. Introduced to minimize code duplication between those classes.

Author:

Marcin Miłkowski

Field Summary

Fields

Modifier and Type	Field and Description
protected int	endPositionCorrection
protected Language	language
protected List<PatternToken>	patternTokens
protected boolean	sentStart
protected int	startPositionCorrection
protected String	subId
protected boolean	testUnification

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
AbstractPatternRule(String id, String description, Language language, List<PatternToken> patternTokens, boolean getUnified)

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
int	getEndPositionCorrection()
String	getId() A string used to identify the rule in e.g. configuration files.
Language	getLanguage()
List<PatternToken>	getPatternTokens()
int	getStartPositionCorrection()
String	getSubId()
boolean	isGetUnified()
boolean	isGroupsOrUnification()
boolean	isSentStart()
boolean	isTestUnification()
RuleMatch[]	match(AnalyzedSentence sentence) Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule.
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	setEndPositionCorrection(int endPositionCorrection)
void	setStartPositionCorrection(int startPositionCorrection)
void	setSubId(String subId)
boolean	supportsLanguage(Language language) Whether this rule can be used for text in the given language.
String	toString()

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getCategory, getCorrectExamples, getIncorrectExamples, getLocQualityIssueType, getUrl, isDefaultOff, isDictionaryBasedSpellingRule, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setIncorrectExamples, setLocQualityIssueType, setUrl, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

language

protected final Language language

patternTokens

protected final List<PatternToken> patternTokens

testUnification

protected final boolean testUnification

sentStart

protected final boolean sentStart

subId

protected String subId

startPositionCorrection

protected int startPositionCorrection

endPositionCorrection

protected int endPositionCorrection

Constructor Detail

AbstractPatternRule

public AbstractPatternRule(String id,
                   String description,
                   Language language,
                   List<PatternToken> patternTokens,
                   boolean getUnified)

Method Detail

supportsLanguage

public boolean supportsLanguage(Language language)

Description copied from class: Rule

Whether this rule can be used for text in the given language. Since LanguageTool 2.6, this also works PatternRules (before, it used to always return false for those).

Overrides:

supportsLanguage in class Rule

toString

public String toString()

Overrides:

toString in class Object

getDescription

public String getDescription()

Description copied from class: Rule

A short description of the error this rule can detect, usually in the language of the text that is checked.

Specified by:

getDescription in class Rule

getId

public String getId()

Description copied from class: Rule

A 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. It's supposed to contain only the characters A-Z and the underscore.

Specified by:

getId in class Rule

match

public RuleMatch[] match(AnalyzedSentence sentence)
                  throws IOException

Description copied from class: Rule

Check whether the given sentence matches this error rule, i.e. whether it contains the error detected by this rule. Note that the order in which this method is called is not always guaranteed, i.e. the sentence order in the text may be different than the order in which you get the sentences (this may be the case when LanguageTool is used as a LibreOffice/OpenOffice add-on, for example).

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

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

getLanguage

public final Language getLanguage()

Since:

2.3

setStartPositionCorrection

public final void setStartPositionCorrection(int startPositionCorrection)

getStartPositionCorrection

public final int getStartPositionCorrection()

setEndPositionCorrection

public final void setEndPositionCorrection(int endPositionCorrection)

getEndPositionCorrection

public final int getEndPositionCorrection()

getSubId

public final String getSubId()

setSubId

public final void setSubId(String subId)

isGroupsOrUnification

public boolean isGroupsOrUnification()

Since:

2.3

isGetUnified

public boolean isGetUnified()

Since:

2.3

isSentStart

public boolean isSentStart()

Since:

2.3

isTestUnification

public boolean isTestUnification()

Since:

2.3

getPatternTokens

public List<PatternToken> getPatternTokens()

Since:

2.3