Package org.languagetool.rules

Interface Summary

Interface	Description
LineExpander
RuleMatchFilter	Filter rule matches.

Class Summary

Class	Description
AbstractAdvancedSynthesizerFilter
AbstractCheckCaseRule	A rule that checks case in phrases
AbstractCompoundRule	Checks that compounds (if in the list) are not written as separate words.
AbstractDashRule	Another use of the compounds file -- check for compounds written with dashes instead of hyphens (for example, Rabka — Zdrój).
AbstractDateCheckFilter	Accepts rule matches if a date doesn't match the accompanying weekday, e.g. if Monday, 8 November 2003 isn't actually a Monday.
AbstractFillerWordsRule	A rule that gives hints about the use of filler words.
AbstractFindSuggestionsFilter
AbstractFutureDateFilter	Checks if a given date is in the future Used for mismatch detection between verb tense and a given date
AbstractMakeContractionsFilter
AbstractNewYearDateFilter	Accepts rule matches if we are in the first days of a new year and the user may have entered a date with the old year (but not a date in December).
AbstractNumberInWordFilter
AbstractPunctuationCheckRule	A rule that matches "
AbstractRepeatedWordsRule
AbstractSimpleReplaceRule	A rule that matches words which should not be used and suggests correct ones instead.
AbstractSimpleReplaceRule2	A rule that matches words which should not be used and suggests correct ones instead.
AbstractSpaceBeforeRule	An abstract rule that checks if there is a missing space before some conjunctions.
AbstractSpecificCaseRule	A rule that matches words which need a specific upper/lowercase spelling.
AbstractStatisticSentenceStyleRule	A rule that gives hints when a defined condition is fulfilled and the percentage of hints in the text exceeds the given limit.
AbstractStatisticStyleRule	A rule that gives hints when a defined condition is fulfilled and the percentage of hints in the text exceeds the given limit.
AbstractStyleRepeatedWordRule	An abstract rule checks the appearance of same words in a sentence or in two consecutive sentences.
AbstractStyleTooOftenUsedWordRule	The method gives stylistic hints that a word is being used too often when the set percentage has been exceeded.
AbstractSuppressIfAnyRuleMatchesFilter
AbstractSuppressMisspelledSuggestionsFilter
AbstractTextToNumberFilter
AbstractUnitConversionRule	Base class providing support for detecting, parsing and converting between measurements in different units
AbstractWordCoherencyRule	A rule that matches words for which two different spellings are used throughout the document.
AdaptSuggestionsFilter
AddCommasFilter
AdvancedWordRepeatRule	Rule for detecting same words in the sentence but not just in a row.
BERTSuggestionRanking	reorder suggestions from another rule using BERT as a LM
Categories	Pre-defined rule categories.
Category	A rule's category.
CategoryId	Identifier for a category.
CategoryIds	Category ids.
CleanOverlappingFilter
CommaWhitespaceRule	A rule that matches periods, commas and closing parenthesis preceded by whitespace and opening parenthesis followed by whitespace.
CompoundRuleData	Data about words that are compounds and should thus not be written as separate words.
ConfusionPair	Two words that can easily be confused - for internal use only.
ConfusionSet	Words that can easily be confused - for internal use only.
ConfusionSetLoader	Loads a confusion set from a plain text file (UTF-8).
ConfusionString	A string in a ConfusionPair - for internal use only.
ConvertToSentenceCaseFilter
CorrectExample	A text, typically a sentence, that doesn't contain an error, at least not one for a specific rule.
DateRangeChecker	Checks whether the date range is valid, i.e., that the starting date happens before the end date.
DemoRule	A simple demo rule as an example for how to implement your own Java-based rule in LanguageTool.
DictionaryMatchFilter
DictionarySpellMatchFilter	Filter spelling error with phrases the users wants to have accepted.
DoublePunctuationRule	A rule that matches ".."
EmptyLineRule	A rule that checks for empty lines.
ErrorTriggeringExample	A text, typically a sentence, that doesn't contain an error, but still leads to an error.
Example	Helper class to create error examples.
ExampleSentence
FakeRule
GenericUnpairedBracketsRule	Rule that finds unpaired quotes, brackets etc.
GenericUnpairedBracketsRule.Symbol
GRPCPostProcessing
GRPCRule	Base class fur rules running on external servers; see gRPC service definition in languagetool-core/src/main/proto/ml_server.proto See #create(Language, ResourceBundle, RemoteRuleConfig, boolean, String, String, Map) for an easy way to add rules; return rule in Language::getRelevantRemoteRules add it like this: public List<Rule> getRelevantRemoteRules(ResourceBundle messageBundle, List<RemoteRuleConfig> configs, GlobalConfig globalConfig, UserConfig userConfig, Language motherTongue, List<Language> altLanguages) throws IOException { List<Rule> rules = new ArrayList<>(super.getRelevantRemoteRules( messageBundle, configs, globalConfig, userConfig, motherTongue, altLanguages)); Rule exampleRule = GRPCRule.create(messageBundle, RemoteRuleConfig.getRelevantConfig("EXAMPLE_ID", configs), "EXAMPLE_ID", "example_rule_id", Collections.singletonMap("example_match_id", "example_rule_message")); rules.add(exampleRule); return rules; }
GRPCRule.Connection
GRPCRule.GRPCSubRule	Internal rule to create rule matches with IDs based on Match Sub-IDs
GRPCUtils
IncorrectExample	A text, typically a sentence, that contains an error.
LanguageDependentFilter
LanguageDependentMergeSuggestionFilter
LongParagraphRule	A rule that warns on long paragraphs.
LongSentenceRule	A rule that warns on long sentences.
MultipleWhitespaceRule	Check if there is duplicated whitespace in a sentence.
MultitokenSpellerFilter
ParagraphRepeatBeginningRule	Check if to paragraphs begin with the same word.
PartialPosTagFilter	Filters rule matches so that only matches are kept where a part of the token has a given POS tag.
PunctuationMarkAtParagraphEnd	A rule that checks for a punctuation mark at the end of a paragraph.
PunctuationMarkAtParagraphEnd2	A rule that checks for a punctuation mark at the end of a paragraph.
ReadabilityRule	A rule that checks the readability of English text (using the Flesch-Reading-Ease Formula) If tooEasyTest == true, the rule tests if paragraph level > level (readability is too easy) If tooEasyTest == false, the rule tests if paragraph level < level (readability is too difficult)
RemoteRule
RemoteRule.RemoteRequest
RemoteRuleConfig
RemoteRuleFilters	rules in remote-rule-filter.xml, same syntax as pattern rules used as filters for results from matches provided by remote rule i.e. if there is a match with equal match span from remote rule and a corresponding filter (i.e. with the same ID as the match) the match is discarded filtering uses the IDs from the matches, so dynamically created rules using different IDs will work
RemoteRuleMetrics
RemoteRuleResult
Rule	Abstract rule class.
RuleMatch	Information about an error rule that matches text and the position of the match.
RuleWithMaxFilter	Filter rule matches so that only the longest match is kept from overlapping matches with the same rule that contains tokens with maxOccurrence > 1.
SameRuleGroupFilter	Filter rule matches so that only the first match is kept from overlapping matches with the same rule group (actually: the same id).
ScoredConfusionSet	Words that can easily be confused - for internal use only.
SentenceWhitespaceRule	Checks that there's whitespace between sentences.
ShortenedYearRangeChecker	Checks whether a shortened year range (such as '1998-92') is valid, i.e., that the starting date happens before the end date.
SimpleReplaceDataLoader	Load replacement data from a UTF-8 file.
SpecificIdRule
SuggestedReplacement
SuggestionFilter	Filter suggestions against a rule.
SuggestionWithMessage
SymbolLocator	Helper class for GenericUnpairedBracketsRule to identify symbols indexed with integers.
SynonymsData
TestRemoteRule
TextLevelRule	A rule that considers the complete text, not just one sentence after the other.
UnsyncStack<E>	Implements unsynchronized stack (contrary to default Java Stack, this one is based on ArrayList).
UppercaseSentenceStartRule	Checks that a sentence starts with an uppercase letter.
WhiteSpaceAtBeginOfParagraph	A rule that checks for WhiteSpaces at the begin of a paragraph
WhiteSpaceBeforeParagraphEnd	A rule that checks for a whitespace at the end of a paragraph
WhitespaceBeforePunctuationRule	A rule that matches several punctuation signs such as : ; and % preceded by whitespace.
WhitespaceCheckFilter
WordCoherencyDataLoader	Loads word variations words from a UTF-8 file.
WordRepeatBeginningRule	Check if three successive sentences begin with the same word, e.g.
WordRepeatRule	Check if a word is repeated, e.g.
WrongWordInContextRule	Check if there is a confusion of two words (which might have a similar spelling) depending on the context.
YMDDateHelper

Enum Summary

Enum	Description
AbstractSimpleReplaceRule2.CaseSensitivy
AbstractUnitConversionRule.Message
Category.Location
GenericUnpairedBracketsRule.Symbol.Type
ITSIssueType	Some constants for Localization Quality Issue Type from the Internationalization Tag Set (ITS) Version 2.0.
RemoteRuleMetrics.RequestResult
RuleMatch.Type	Unlike Category, this is specific to a RuleMatch, not to a rule.
SuggestedReplacement.SuggestionType	classify the type of the suggestion so that downstream tasks (e.g. resorting, as in BERTSuggestionRanking) can treat them accordingly Default - default, no special treatment Translation - offers to translate words from native language into text language; suggestion ranking extends size of list of candidates Curated - a manually curated suggestion / special case / ...; don't resort