All Classes and Interfaces
Class
Description
Checks that compounds (if in the list) are not written as separate words.
Another use of the compounds file -- check for compounds written with
dashes instead of hyphens (for example, Rabka — Zdrój).
Accepts rule matches if a date doesn't match the accompanying weekday, e.g.
Abstract Disambiguator class to provide default (empty) implementation
for
Disambiguator.preDisambiguate(AnalyzedSentence).A rule that gives hints about the use of filler words.
Checks if a given date is in the future
Used for mismatch detection between verb tense and a given date
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).
An Abstract Pattern Rule that describes a pattern of words or part-of-speech tags
used for PatternRule and DisambiguationPatternRule.
A rule that matches "..", "::", "-," but not "...", "!..", "?!!", ",-" etc.
A rule that matches words which should not be used and suggests
correct ones instead.
A rule that matches words which should not be used and suggests correct ones instead.
An abstract rule that checks if there is a missing space before some conjunctions.
An abstract rule checks the appearance of same words in a sentence or in two consecutive sentences.
Base class providing support for detecting, parsing and converting between measurements in different units
A rule that matches words for which two different spellings are used
throughout the document.
Rule for detecting same words in the sentence but not just in a row.
A sentence that has been tokenized and analyzed.
A word (or punctuation, or whitespace) and its analysis (part-of-speech tag, lemma)
An array of
AnalyzedTokens used to store multiple POS tags and lemmas
for a given single token.A text with markup and with a mapping so error positions will refer to the original
position that includes the markup, even though only the plain text parts are checked.
Use this builder to create input of text with markup for LanguageTool, so that it
can check only the plain text parts and ignore the markup, yet still calculate the
positions of errors so that they refer to the complete text, including markup.
An internal marker for places in the source where the API would need to be cleaned up.
The algorithm of a language model, independent of the way data
is stored (see sub classes for that).
Base tagger using Morfologik binary dictionaries.
A bitext pattern rule class.
Loads
PatternRules from an XML file.Interface for classes that implement reading from bitext files,
such as translation memory files, glossary files, aligned text...
Abstract bitext rule class.
Helper to load text files from classpath.
Pre-defined rule categories.
A rule's category.
Identifier for a category.
Category ids.
Assign chunks (i.e.
The name of a chunk.
Tags a word using two taggers, combining their results.
A rule that matches periods, commas and closing parenthesis preceded by whitespace and
opening parenthesis followed by whitespace.
Information about common words - use as a fallback if language identification yields low confidence.
A spell checker that combines Hunspell und Morfologik spell checking
to support compound words and offer fast suggestions for some misspelled
compound words.
Data about words that are compounds and should thus not be written
as separate words.
Interface for components that take compound words and split
them into their parts.
Two words that can easily be confused - for internal use only.
LanguageTool's homophone confusion check that uses ngram lookups
to decide which word in a confusion set (from
confusion_sets.txt) suits best.Words that can easily be confused - for internal use only.
Loads a confusion set from a plain text file (UTF-8).
A string in a
ConfusionPair - for internal use only.Helper class to mark errors in text.
A person that contributed rules or code to LanguageTool.
Constants for contributors who contribute to more than one language (use to avoid duplication).
A text, typically a sentence, that doesn't contain an error,
at least not one for a specific rule.
Checks whether the date range is valid, i.e., that the starting
date happens before the end date.
Responsible for getting any items from the grammar checker's resource
directories.
Trivial disambiguator.
A simple demo rule as an example for how to implement your own Java-based
rule in LanguageTool.
A trivial tagger that does nothing than assign null
tags to words.
Checks if the translation has a really different length than the source
(smaller than 30% or longer by 250%).
Checks if the translation has the same ending punctuation as the source.
Disambiguated example.
A Rule that describes a pattern of words or part-of-speech tags used for
disambiguation.
Possible disambiguator actions.
Loads
DisambiguationPatternRules from a disambiguation rules XML
file.Disambiguator interface.
A rule that matches ".." (but not "..." etc) and ",,".
A rule that checks for empty lines.
A text, typically a sentence, that doesn't contain an error,
but still leads to an error.
Helper class to create error examples.
An experimental feature that may change without warning in future versions.
A pattern rule for finding false friends.
Loads
PatternRules from a false friends XML file.Loads the false friend rules as bitext pattern rules.
Rule that finds unpaired quotes, brackets etc.
A token as tokenized in the Google ngram index.
The simple hunspell library frontend which takes care of creating
and singleton'ing the library instance (no need to load it more than once
per process).
Functions from $hunspell/src/hunspell/hunspell.h
The Hunspell java bindings are licensed under the same terms as Hunspell itself (GPL/LGPL/MPL tri-license),
see the file COPYING.txt in the root of the distribution for the exact terms.
Like
HunspellRule, but does not offer suggestions for incorrect words
as that is very slow with Hunspell.A hunspell-based spellchecking-rule.
XML Filter that ignores whitespace-only nodes.
A text, typically a pair of sentences that contains an error.
A text, typically a sentence, that contains an error.
For internal use only.
CharSequence that noticed thread interrupts -- as might be necessary
to recover from a loose regex on unexpected challenging input.
Some constants for Localization Quality Issue Type from the
Internationalization Tag Set (ITS) Version 2.0.
The main class used for checking text against different rules:
built-in Java rules (for English: a vs.
Constants for correct paragraph-rule handling.
JNA helper tools.
Base class for any supported language (English, German, etc).
Create a language by specifying the language's XML rule file.
Identify the language of a text.
Information about whether a language in LanguageTool is actively maintained.
A language model that provides information about ngram probabilities.
Helper methods to list all supported languages and to get language objects
by their name or language code etc.
Dummy class for UserConfig
has to be overridden by concrete linguistic service e.g.
A rule that warns on long paragraphs.
A rule that warns on long sentences.
Like
LuceneSingleIndexLanguageModel, but can merge the results of
lookups in several independent indexes to one result.Information about ngram occurrences, taken from Lucene indexes (one index per ngram level).
A synthesizer that reads the inflected form and POS information from a plain (UTF-8) text file.
A tagger that reads the POS information from a plain (UTF-8) text file.
A fake markup data object giving information on the impact of the fake markup.
A
Match is the configuration of an algorithm used to match AnalyzedTokenReadingss.Possible string case conversions.
The state of a matching process.
Produces zero probability for any passed text.
Morfologik speller that merges results from binary (.dict) and plain text (.txt) dictionaries.
Morfologik-based spell checker.
Tags a word using a Morfologik binary dictionary.
A very simple property-style configuration.
Combines the results of several
LanguageModels.Check if there is duplicated whitespace in a sentence.
A variant of
JLanguageTool that uses several threads for rule matching.Multiword tagger-chunker.
Multiword tagger-chunker.
LanguageTool's probability check that uses ngram lookups
to decide if an ngram of the input text is so rare in our
ngram index that it should be considered an error.
No-op chunker.
A language that is part of languagetool-core but that hasn't any rules.
Queries an OpenNMT server started like this:
th tools/rest_translation_server.lua -replace_unk -model ...Check if to paragraphs begin with the same word.
Filters rule matches so that only matches are kept where a part of the
token has a given POS tag.
Authenticator that extracts username and password from URL, e.g.
A Rule that describes a language error as a simple pattern of words or of
part-of-speech tags.
A
PatternRule's id with an optional sub-id.Loads
PatternRules from an XML file.Matches a pattern rule against text.
Makes XML definition of rules accessible as strings.
A part of a pattern, represents the 'token' element of the
grammar.xml.Helper to build
PatternTokens.Probability, but doesn't check for a range of 0 to 1.
A rule that checks for a punctuation mark at the end of a paragraph.
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)
Matches 'regexp' elements from XML rules against sentences.
Message bundle helper class used for translation of the user interface.
A resource bundle that uses its fallback resource bundle if the
value from the original bundle is null or empty.
Is responsible for getting the necessary resources for the grammar checker
library.
A cache to speed up text checking for use cases where sentences are checked more than once.
Abstract rule class.
Thrown if external rule filename doesn't match the required format.
Filter rule matches after a PatternRule has matched already.
Create a
RuleFilter.Evaluates a
RuleFilter.Information about an error rule that matches text and the position of the match.
Unlike
Category, this is specific to a RuleMatch, not to a rule.Deprecated.
don't use for new use cases, the only place this should still be used is for the API mode of the command-line client (deprecated since 3.5)
Write rule matches and some meta information as JSON.
Filter rule matches.
Filter rule matches so that only the longest match is kept from overlapping
matches with the same rule that contains tokens with maxOccurrence > 1.
Filter rule matches so that only the first match is kept from overlapping
matches with the same rule group (actually: the same id).
Checks if the translation for segments that have more than two words
is different.
Words that can easily be confused - for internal use only.
Loads a confusion set from a plain text file (UTF-8).
Tokenizes text into sentences.
Checks that there's whitespace between sentences.
Provide short (~ up to 30 characters) descriptions for words.
Checks whether a shortened year range (such as '1998-92') is valid, i.e., that the starting
date happens before the end date.
For internal use only.
Load replacement data from a UTF-8 file.
A very simple sentence tokenizer that splits on
[.!?…] followed by whitespace
or an uppercase letter.An abstract rule for spellchecking rules.
Class to tokenize sentences using rules from an SRX file.
Tools for loading an SRX tokenizer file.
A convenience class to work with bitext strings.
Tools for working with strings.
Constants for printing XML rule matches.
Filter suggestions against a rule.
Helper class for SuggestionChangesTest, tracks experiment configuration and results
Rules should use getInstance() != null -> getInstance().getCurrentExperiment() in constructors to fetch relevant parameters
Use isRunningExperiment if no parameters are needed
Computes features that can be stored for training a model to rank suggestions,
or when using the same model for prediction
Used directly by SuggestionChangesTest for the former,
and as a superclass for the latter
Deprecated.
Deprecated.
still work in progress
Implementing classes must provide confidence values with the SuggestedReplacement objects returned by orderSuggestions
Helper class for
GenericUnpairedBracketsRule to identify
symbols indexed with integers.spell checking using SymSpell algorithm, implementation from
https://github.com/Lundez/JavaSymSpell in org.languagetool.rules.spelling.symspell.implementation
potential faster alternative to Morfologik, especially in generating suggestions
Part-of-speech synthesizer interface.
Reader of simple tab-delimited bilingual files.
Result of
WordTagger.The part-of-speech tagger interface, whose implementations are usually language-dependent.
A rule that considers the complete text, not just one sentence after
the other.
A part of a text with markup, either plain text (to be checked by LanguageTool),
or markup (to be ignored by LanguageTool).
Interface for classes that tokenize text into smaller units.
Implements unification of features over tokens.
Implements unsynchronized stack (contrary to default Java
Stack,
this one is based on ArrayList).Checks that a sentence starts with an uppercase letter.
User-specific configuration.
A rule that checks for WhiteSpaces at the begin of a paragraph
A rule that checks for a whitespace at the end of a paragraph
A rule that matches several punctuation signs such as
: ; and % preceded by whitespace.Loads word variations words from a UTF-8 file.
Reader of WordFast Translation Memory text files.
Check if three successive sentences begin with the same word, e.g.
Check if a word is repeated, e.g.
Find the potential part-of-speech tags (POS tags) for a word.
Tokenizes a sentence into words.
Check if there is a confusion of two words (which might have a similar spelling) depending on the context.
Rule-based disambiguator.
XML rule handler that loads rules from XML and throws
exceptions on errors and warnings.
Validate XML files with a given DTD or XML Schema (XSD).
XML handler that throws exception on error and warning, does nothing otherwise.