org.languagetool.rules.patterns

Class PatternRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.patterns.AbstractPatternRule

org.languagetool.rules.patterns.PatternRule

Direct Known Subclasses:

FalseFriendPatternRule

public class PatternRule
extends AbstractPatternRule

A Rule that describes a language error as a simple pattern of words or of part-of-speech tags.

Author:

Daniel Naber

Field Summary

Fields inherited from class org.languagetool.rules.patterns.AbstractPatternRule

endPositionCorrection, language, patternTokens, sentStart, startPositionCorrection, subId, testUnification

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
PatternRule(String id, Language language, List<PatternToken> patternTokens, String description, String message, String shortMessage)
PatternRule(String id, Language language, List<PatternToken> patternTokens, String description, String message, String shortMessage, String suggestionsOutMsg)
PatternRule(String id, Language language, List<PatternToken> patternTokens, String description, String message, String shortMessage, String suggestionsOutMsg, boolean isMember)

Method Summary

Methods

Modifier and Type	Method and Description
void	addSuggestionMatch(Match m) Add formatted suggestion elements.
void	addSuggestionMatchOutMsg(Match m) Add formatted suggestion elements outside message.
boolean	canBeIgnoredFor(AnalyzedSentence sentence) A fast check whether this rule can be ignored for the given sentence because it can never match.
String	getMessage() Get the message shown to the user if this rule matches.
String	getSuggestionsOutMsg()
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	setAntiPatterns(List<DisambiguationPatternRule> antiPatterns) Set up the list of antipatterns used to immunize tokens, i.e., make them non-matchable by the current rule.
void	setMessage(String message) Set the message shown to the user if this rule matches.
String	toPatternString() Return the pattern as a string, using toString() on the pattern elements.
String	toXML() Return the rule's definition as an XML string, loaded from the XML rule files.

Methods inherited from class org.languagetool.rules.patterns.AbstractPatternRule

getDescription, getEndPositionCorrection, getId, getLanguage, getPatternTokens, getStartPositionCorrection, getSubId, isGetUnified, isGroupsOrUnification, isSentStart, isTestUnification, reset, setEndPositionCorrection, setStartPositionCorrection, setSubId, supportsLanguage, 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

Constructor Detail

PatternRule

public PatternRule(String id,
           Language language,
           List<PatternToken> patternTokens,
           String description,
           String message,
           String shortMessage)

Parameters:

id - Id of the Rule. Used in configuration. Should not contain special characters and should be stable over time, unless the rule changes completely.

language - Language of the Rule

description - Description to be shown (name)

message - Message to be displayed to the user

shortMessage - Message to be displayed to the user in the context menu in OpenOffice.org/LibreOffice

PatternRule

public PatternRule(String id,
           Language language,
           List<PatternToken> patternTokens,
           String description,
           String message,
           String shortMessage,
           String suggestionsOutMsg)

PatternRule

public PatternRule(String id,
           Language language,
           List<PatternToken> patternTokens,
           String description,
           String message,
           String shortMessage,
           String suggestionsOutMsg,
           boolean isMember)

Method Detail

getMessage

public final String getMessage()

Get the message shown to the user if this rule matches.

setMessage

public final void setMessage(String message)

Set the message shown to the user if this rule matches.

getSuggestionsOutMsg

public final String getSuggestionsOutMsg()

toPatternString

public final String toPatternString()

Return the pattern as a string, using toString() on the pattern elements.

Since:

0.9.2

toXML

public final String toXML()

Return the rule's definition as an XML string, loaded from the XML rule files.

Since:

0.9.3

match

public final 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).

Overrides:

match in class AbstractPatternRule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

addSuggestionMatch

public final void addSuggestionMatch(Match m)

Add formatted suggestion elements.

addSuggestionMatchOutMsg

public final void addSuggestionMatchOutMsg(Match m)

Add formatted suggestion elements outside message.

canBeIgnoredFor

public boolean canBeIgnoredFor(AnalyzedSentence sentence)

A fast check whether this rule can be ignored for the given sentence because it can never match. Used internally for performance optimization.

Since:

2.4

setAntiPatterns

public void setAntiPatterns(List<DisambiguationPatternRule> antiPatterns)

Set up the list of antipatterns used to immunize tokens, i.e., make them non-matchable by the current rule. Useful for multi-word complex exceptions, such as multi-word idiomatic expressions.

Parameters:

antiPatterns - A list of antiPatterns, implemented as DisambiguationPatternRule.

Since:

2.5