Package org.languagetool.rules.patterns
Class RegexPatternRule
java.lang.Object
org.languagetool.rules.Rule
org.languagetool.rules.patterns.AbstractPatternRule
org.languagetool.rules.patterns.RegexPatternRule
- All Implemented Interfaces:
RuleMatcher
Matches 'regexp' elements from XML rules against sentences.
- Since:
- 3.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
private static final int
private static final Pattern
private final Pattern
private final String
private static final Pattern
Fields inherited from class org.languagetool.rules.patterns.AbstractPatternRule
antiPatterns, endPositionCorrection, filter, filterArgs, language, message, patternTokens, regex, regexMark, sentStart, sourceFile, startPositionCorrection, subId, suggestionMatches, suggestionMatchesOutMsg, suggestionsOutMsg, testUnification
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid.getClausePositionsInMessage
(Pattern pattern, String message) (package private) String
match
(AnalyzedSentence sentenceObj) Check whether the given sentence matches this error rule, i.e.private String
processMessage
(Matcher matcher, String message, List<org.apache.commons.lang3.tuple.Pair<Integer, Integer>> backReferences, List<org.apache.commons.lang3.tuple.Pair<Integer, Integer>> suggestions, List<Match> matches) toString()
Methods inherited from class org.languagetool.rules.patterns.AbstractPatternRule
addSuggestionMatch, addSuggestionMatchOutMsg, getAntiPatterns, getDescription, getEndPositionCorrection, getFilter, getFilterArguments, getFullId, getId, getLanguage, getMessage, getPatternRuleId, getPatternTokens, getSourceFile, getStartPositionCorrection, getSubId, getSuggestionMatches, getSuggestionMatchesOutMsg, getSuggestionsOutMsg, isGetUnified, isGroupsOrUnification, isSentStart, isTestUnification, setAntiPatterns, setEndPositionCorrection, setFilter, setFilterArguments, setMessage, setSourceFile, setStartPositionCorrection, setSubId, supportsLanguage
Methods inherited from class org.languagetool.rules.Rule
addExamplePair, getCategory, getConfigureText, getCorrectExamples, getDefaultValue, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMaxConfigurableValue, getMinConfigurableValue, getSentenceWithImmunization, getUrl, hasConfigurableValue, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isOfficeDefaultOff, isOfficeDefaultOn, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setErrorTriggeringExamples, setIncorrectExamples, setLocQualityIssueType, setOfficeDefaultOff, setOfficeDefaultOn, setUrl, toRuleMatchArray, useInOffice
-
Field Details
-
suggestionPattern
-
matchPattern
-
MATCHES_IN_SUGGESTIONS_NUMBERED_FROM
private static final int MATCHES_IN_SUGGESTIONS_NUMBERED_FROM- See Also:
-
pattern
-
markGroup
private final int markGroup -
shortMessage
-
-
Constructor Details
-
RegexPatternRule
-
-
Method Details
-
getPattern
-
match
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 interfaceRuleMatcher
- Overrides:
match
in classAbstractPatternRule
- Parameters:
sentenceObj
- a pre-analyzed sentence- Returns:
- an array of
RuleMatch
objects - Throws:
IOException
-
getClausePositionsInMessage
-
processMessage
-
estimateContextForSureMatch
public int estimateContextForSureMatch()Description copied from class:Rule
A number that estimates how many words there must be after a match before we can be (relatively) sure the match is valid. This is useful for check-as-you-type, where a match might occur and the word that gets typed next makes the match disappear (something one would obviously like to avoid). Note: this may over-estimate the real context size. Returns-1
when the sentence needs to end to be sure there's a match.- Overrides:
estimateContextForSureMatch
in classRule
-
toString
- Overrides:
toString
in classAbstractPatternRule
-
getShortMessage
String getShortMessage()- Overrides:
getShortMessage
in classAbstractPatternRule
- Returns:
- String of short message as specified in <short>...</short>
-