JLanguageTool (LanguageTool Style and Grammar Checker Core 3.0 API)

java.lang.Object
- org.languagetool.JLanguageTool

Direct Known Subclasses:

MultiThreadedJLanguageTool
```
public class JLanguageTool
extends Object
```
The main class used for checking text against different rules:
- built-in Java rules (for English: a vs. an, whitespace after commas, ...)
- built-in pattern rules loaded from external XML files (usually called grammar.xml)
- your own implementation of the abstract Rule classes added with addRule(Rule)
You will probably want to use the sub class MultiThreadedJLanguageTool for best performance.
Unicode: LanguageTool expects text in Normalization Form KC (NFKC). For example, the German character 'ü' (lowercase u umlaut) must be in the string as Unicode character U+00FC, not as 'u' followed by the combining diaeresis character. See the Oracle docs on normalizing text.

Thread-safety: this class is not thread safe. Create one instance per thread, but create the language only once (e.g. new English()) and use it for all instances of JLanguageTool.
See Also:
MultiThreadedJLanguageTool

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`JLanguageTool.ParagraphHandling` Constants for correct paragraph-rule handling: NORMAL - all kinds of rules run ONLYPARA - only paragraph-level rules ONLYNONPARA - only sentence-level rules

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BUILD_DATE` LanguageTool build date and time like `2013-10-17 16:10` or `null` if not run from JAR.
`static String`	`FALSE_FRIEND_FILE` The name of the file with false friend information.
`static String`	`MESSAGE_BUNDLE` Name of the message bundle for translations.
`static String`	`PARAGRAPH_END_TAGNAME` The internal tag used to mark the end of a paragraph.
`static String`	`PATTERN_FILE` The name of the file with error patterns.
`static String`	`SENTENCE_END_TAGNAME` The internal tag used to mark the end of a sentence.
`static String`	`SENTENCE_START_TAGNAME` The internal tag used to mark the beginning of a sentence.
`static String`	`VERSION` LanguageTool version as a string like `2.3` or `2.4-SNAPSHOT`.

Constructor Summary

Constructors
Constructor and Description
`JLanguageTool(Language language)` Create a JLanguageTool and setup the built-in Java rules for the given language.
`JLanguageTool(Language language, Language motherTongue)` Create a JLanguageTool and setup the built-in rules for the given language and false friend rules for the text language / mother tongue pair.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activateLanguageModelRules(File indexDir)` Activate rules that depend on a language model.
`void`	`addRule(Rule rule)` Add a rule to be used by the next call to the check methods like `check(String)`.
`static void`	`addTemporaryFile(File file)` Adds a temporary file to the internal list (internal method, you should never need to call this as a user of LanguageTool)
`RuleMatch`	`adjustRuleMatchPos(RuleMatch match, int charCount, int columnCount, int lineCount, String sentence, AnnotatedText annotatedText)` Change RuleMatch positions so they are relative to the complete text, not just to the sentence.
`protected List<AnalyzedSentence>`	`analyzeSentences(List<String> sentences)`
`List<AnalyzedSentence>`	`analyzeText(String text)` Use this method if you want to access LanguageTool's otherwise internal analysis of the text.
`List<RuleMatch>`	`check(AnnotatedText text)` The main check method.
`List<RuleMatch>`	`check(AnnotatedText annotatedText, boolean tokenizeText, JLanguageTool.ParagraphHandling paraMode)` The main check method.
`List<RuleMatch>`	`check(String text)` The main check method.
`List<RuleMatch>`	`check(String text, boolean tokenizeText, JLanguageTool.ParagraphHandling paraMode)`
`List<RuleMatch>`	`checkAnalyzedSentence(JLanguageTool.ParagraphHandling paraMode, List<Rule> allRules, int charCount, int lineCount, int columnCount, String sentence, AnalyzedSentence analyzedSentence)` Deprecated. will be made non-public, please use one of the `check(String)` methods instead (deprecated since 3.0)
`List<RuleMatch>`	`checkAnalyzedSentence(JLanguageTool.ParagraphHandling paraMode, List<Rule> rules, int charCount, int lineCount, int columnCount, String sentence, AnalyzedSentence analyzedSentence, AnnotatedText annotatedText)` This is an internal method that's public only for technical reasons, please use one of the `check(String)` methods instead.
`void`	`disableCategory(String categoryName)` Disable the given rule category so the check methods like `check(String)` won't use it.
`void`	`disableRule(String ruleId)` Disable a given rule so the check methods like `check(String)` won't use it.
`void`	`disableRules(List<String> ruleIds)` Disable the given rules so the check methods like `check(String)` won't use them.
`void`	`enableDefaultOffRule(String ruleId)` Enable a rule that is switched off by default (`default="off"` in the XML).
`void`	`enableRule(String ruleId)` Re-enable a given rule so the check methods like `check(String)` will use it.
`List<Rule>`	`getAllActiveRules()` Get all active (not disabled) rules for the current language that are built-in or that have been added using e.g.
`List<Rule>`	`getAllRules()` Get all rules for the current language that are built-in or that have been added using `addRule(Rule)`.
`AnalyzedSentence`	`getAnalyzedSentence(String sentence)` Tokenizes the given `sentence` into words and analyzes it, and then disambiguates POS tags.
`static ResourceDataBroker`	`getDataBroker()` The grammar checker needs resources from following directories: `/resource` `/rules` This method is thread-safe.
`Set<String>`	`getDisabledCategories()` Get category ids of the rule categories that have been explicitly disabled.
`Set<String>`	`getDisabledRules()` Get rule ids of the rules that have been explicitly disabled.
`Language`	`getLanguage()` Get the language that was used to configure this instance.
`static ResourceBundle`	`getMessageBundle()` Gets the ResourceBundle (i18n strings) for the default language of the user's system.
`static ResourceBundle`	`getMessageBundle(Language lang)` Gets the ResourceBundle (i18n strings) for the given user interface language.
`List<PatternRule>`	`getPatternRulesByIdAndSubId(String Id, String subId)` Get pattern rules by Id and SubId.
`AnalyzedSentence`	`getRawAnalyzedSentence(String sentence)` Tokenizes the given `sentence` into words and analyzes it.
`int`	`getSentenceCount()` Deprecated. use `analyzeText(String)` instead (deprecated since 2.7)
`List<String>`	`getUnknownWords()` Get the alphabetically sorted list of unknown words in the latest run of one of the `check(String)` methods.
`List<PatternRule>`	`loadFalseFriendRules(String filename)` Load false friend rules from an XML file.
`List<PatternRule>`	`loadPatternRules(String filename)` Load pattern rules from an XML file.
`protected List<RuleMatch>`	`performCheck(List<AnalyzedSentence> analyzedSentences, List<String> sentences, List<Rule> allRules, JLanguageTool.ParagraphHandling paraMode, AnnotatedText annotatedText)`
`protected void`	`printIfVerbose(String s)`
`protected void`	`printSentenceInfo(AnalyzedSentence analyzedSentence)`
`protected void`	`rememberUnknownWords(AnalyzedSentence analyzedText)`
`static void`	`removeTemporaryFiles()` Clean up all temporary files, if there are any.
`List<String>`	`sentenceTokenize(String text)` Tokenizes the given text into sentences.
`static void`	`setDataBroker(ResourceDataBroker broker)` The grammar checker needs resources from following directories: `/resource` `/rules` This method is thread-safe.
`void`	`setListUnknownWords(boolean listUnknownWords)` Whether the `check(String)` methods store unknown words.
`void`	`setOutput(PrintStream printStream)` Set a PrintStream that will receive verbose output.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final String VERSION
```
    LanguageTool version as a string like 2.3 or 2.4-SNAPSHOT.
    
    See Also:
    Constant Field Values
  - BUILD_DATE
```
@Nullable
public static final String BUILD_DATE
```
    LanguageTool build date and time like 2013-10-17 16:10 or null if not run from JAR.
  - PATTERN_FILE
```
public static final String PATTERN_FILE
```
    The name of the file with error patterns.
    
    See Also:
    Constant Field Values
  - FALSE_FRIEND_FILE
```
public static final String FALSE_FRIEND_FILE
```
    The name of the file with false friend information.
    
    See Also:
    Constant Field Values
  - SENTENCE_START_TAGNAME
```
public static final String SENTENCE_START_TAGNAME
```
    The internal tag used to mark the beginning of a sentence.
    
    See Also:
    Constant Field Values
  - SENTENCE_END_TAGNAME
```
public static final String SENTENCE_END_TAGNAME
```
    The internal tag used to mark the end of a sentence.
    
    See Also:
    Constant Field Values
  - PARAGRAPH_END_TAGNAME
```
public static final String PARAGRAPH_END_TAGNAME
```
    The internal tag used to mark the end of a paragraph.
    
    See Also:
    Constant Field Values
  - MESSAGE_BUNDLE
```
public static final String MESSAGE_BUNDLE
```
    Name of the message bundle for translations.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - JLanguageTool
```
public JLanguageTool(Language language)
```
    Create a JLanguageTool and setup the built-in Java rules for the given language.
    
    Parameters:
    language - the language of the text to be checked
  - JLanguageTool
```
public JLanguageTool(Language language,
             Language motherTongue)
```
    Create a JLanguageTool and setup the built-in rules for the given language and false friend rules for the text language / mother tongue pair.
    
    Parameters:
    language - the language of the text to be checked
    motherTongue - the user's mother tongue, used for false friend rules, or null. The mother tongue may also be used as a source language for checking bilingual texts.
- Method Detail
  - getDataBroker
```
public static ResourceDataBroker getDataBroker()
```
    The grammar checker needs resources from following directories:
    - /resource
    - /rules
    This method is thread-safe.
    Returns:
    The currently set data broker which allows to obtain resources from the mentioned directories above. If no data broker was set, a new DefaultResourceDataBroker will be instantiated and returned.
    Since:
    
    1.0.1
  - setDataBroker
```
public static void setDataBroker(ResourceDataBroker broker)
```
    The grammar checker needs resources from following directories:
    - /resource
    - /rules
    This method is thread-safe.
    Parameters:
    broker - The new resource broker to be used.
    Since:
    
    1.0.1
  - setListUnknownWords
```
public void setListUnknownWords(boolean listUnknownWords)
```
    Whether the check(String) methods store unknown words. If set to true (default: false), you can get the list of unknown words using getUnknownWords().
  - getMessageBundle
```
public static ResourceBundle getMessageBundle()
```
    Gets the ResourceBundle (i18n strings) for the default language of the user's system.
  - getMessageBundle
```
public static ResourceBundle getMessageBundle(Language lang)
```
    Gets the ResourceBundle (i18n strings) for the given user interface language.
    
    Since:
    
    2.4 (public since 2.4)
  - setOutput
```
public void setOutput(PrintStream printStream)
```
    Set a PrintStream that will receive verbose output. Set to null (which is the default) to disable verbose output.
  - loadPatternRules
```
public List<PatternRule> loadPatternRules(String filename)
                                   throws IOException
```
    Load pattern rules from an XML file. Use addRule(Rule) to add these rules to the checking process.
    
    Parameters:
    filename - path to an XML file in the classpath or in the filesystem - the classpath is checked first
    
    Returns:
    a List of PatternRule objects
    
    Throws:
    
    IOException
  - loadFalseFriendRules
```
public List<PatternRule> loadFalseFriendRules(String filename)
                                       throws ParserConfigurationException,
                                              SAXException,
                                              IOException
```
    Load false friend rules from an XML file. Only those pairs will be loaded that match the current text language and the mother tongue specified in the JLanguageTool constructor. Use addRule(Rule) to add these rules to the checking process.
    
    Parameters:
    filename - path to an XML file in the classpath or in the filesystem - the classpath is checked first
    
    Returns:
    a List of PatternRule objects, or an empty list if mother tongue is not set
    
    Throws:
    
    ParserConfigurationException
    
    SAXException
    
    IOException
  - activateLanguageModelRules
```
public void activateLanguageModelRules(File indexDir)
                                throws IOException
```
    Activate rules that depend on a language model. The language model currently consists of Lucene indexes with ngram occurrence counts.
    
    Parameters:
    indexDir - directory with a '3grams' sub directory which contains a Lucene index with 3gram occurrence counts
    
    Throws:
    
    IOException
    Since:
    
    2.7
  - addRule
```
public void addRule(Rule rule)
```
    Add a rule to be used by the next call to the check methods like check(String).
  - disableRule
```
public void disableRule(String ruleId)
```
    Disable a given rule so the check methods like check(String) won't use it.
    
    Parameters:
    ruleId - the id of the rule to disable - no error will be thrown if the id does not exist
  - disableRules
```
public void disableRules(List<String> ruleIds)
```
    Disable the given rules so the check methods like check(String) won't use them.
    
    Parameters:
    ruleIds - the ids of the rules to disable - no error will be thrown if the id does not exist
    Since:
    
    2.4
  - disableCategory
```
public void disableCategory(String categoryName)
```
    Disable the given rule category so the check methods like check(String) won't use it.
    
    Parameters:
    categoryName - the id of the category to disable - no error will be thrown if the id does not exist
  - getLanguage
```
public Language getLanguage()
```
    Get the language that was used to configure this instance.
  - getDisabledRules
```
public Set<String> getDisabledRules()
```
    Get rule ids of the rules that have been explicitly disabled.
  - enableDefaultOffRule
```
public void enableDefaultOffRule(String ruleId)
```
    Enable a rule that is switched off by default (default="off" in the XML).
    
    Parameters:
    ruleId - the id of the turned off rule to enable.
  - getDisabledCategories
```
public Set<String> getDisabledCategories()
```
    Get category ids of the rule categories that have been explicitly disabled.
  - enableRule
```
public void enableRule(String ruleId)
```
    Re-enable a given rule so the check methods like check(String) will use it. Note that you need to use enableDefaultOffRule(String) for rules that are off by default. This will not throw an exception if the given rule id doesn't exist.
    
    Parameters:
    ruleId - the id of the rule to enable
  - sentenceTokenize
```
public List<String> sentenceTokenize(String text)
```
    Tokenizes the given text into sentences.
  - check
```
public List<RuleMatch> check(String text)
                      throws IOException
```
    The main check method. Tokenizes the text into sentences and matches these sentences against all currently active rules.
    
    Parameters:
    text - the text to be checked
    
    Returns:
    a List of RuleMatch objects
    
    Throws:
    
    IOException
  - check
```
public List<RuleMatch> check(String text,
                    boolean tokenizeText,
                    JLanguageTool.ParagraphHandling paraMode)
                      throws IOException
```
    Throws:
    
    IOException
  - check
```
public List<RuleMatch> check(AnnotatedText text)
                      throws IOException
```
    The main check method. Tokenizes the text into sentences and matches these sentences against all currently active rules, adjusting error positions so they refer to the original text including markup.
    
    Throws:
    
    IOException
    Since:
    
    2.3
  - check
```
public List<RuleMatch> check(AnnotatedText annotatedText,
                    boolean tokenizeText,
                    JLanguageTool.ParagraphHandling paraMode)
                      throws IOException
```
    The main check method. Tokenizes the text into sentences and matches these sentences against all currently active rules.
    
    Parameters:
    annotatedText - The text to be checked, created with AnnotatedTextBuilder. Call this method with the complete text to be checked. If you call it repeatedly with smaller chunks like paragraphs or sentence, those rules that work across paragraphs/sentences won't work (their status gets reset whenever this method is called).
    tokenizeText - If true, then the text is tokenized into sentences. Otherwise, it is assumed it's already tokenized, i.e. it is only one sentence
    paraMode - Uses paragraph-level rules only if true.
    
    Returns:
    a List of RuleMatch objects, describing potential errors in the text
    
    Throws:
    
    IOException
    Since:
    
    2.3
  - analyzeText
```
public List<AnalyzedSentence> analyzeText(String text)
                                   throws IOException
```
    Use this method if you want to access LanguageTool's otherwise internal analysis of the text. For actual text checking, use the check... methods instead.
    
    Parameters:
    text - The text to be analyzed
    
    Throws:
    
    IOException
    Since:
    
    2.5
  - analyzeSentences
```
protected List<AnalyzedSentence> analyzeSentences(List<String> sentences)
                                           throws IOException
```
    Throws:
    
    IOException
  - printSentenceInfo
```
protected void printSentenceInfo(AnalyzedSentence analyzedSentence)
```
  - performCheck
```
protected List<RuleMatch> performCheck(List<AnalyzedSentence> analyzedSentences,
                           List<String> sentences,
                           List<Rule> allRules,
                           JLanguageTool.ParagraphHandling paraMode,
                           AnnotatedText annotatedText)
                                throws IOException
```
    Throws:
    
    IOException
  - checkAnalyzedSentence
```
public List<RuleMatch> checkAnalyzedSentence(JLanguageTool.ParagraphHandling paraMode,
                                    List<Rule> allRules,
                                    int charCount,
                                    int lineCount,
                                    int columnCount,
                                    String sentence,
                                    AnalyzedSentence analyzedSentence)
                                      throws IOException
```
    Deprecated. will be made non-public, please use one of the check(String) methods instead (deprecated since 3.0)
    
    Throws:
    
    IOException
  - checkAnalyzedSentence
```
public List<RuleMatch> checkAnalyzedSentence(JLanguageTool.ParagraphHandling paraMode,
                                    List<Rule> rules,
                                    int charCount,
                                    int lineCount,
                                    int columnCount,
                                    String sentence,
                                    AnalyzedSentence analyzedSentence,
                                    AnnotatedText annotatedText)
                                      throws IOException
```
    This is an internal method that's public only for technical reasons, please use one of the check(String) methods instead.
    
    Throws:
    
    IOException
    Since:
    
    2.3
  - adjustRuleMatchPos
```
public RuleMatch adjustRuleMatchPos(RuleMatch match,
                           int charCount,
                           int columnCount,
                           int lineCount,
                           String sentence,
                           AnnotatedText annotatedText)
```
    Change RuleMatch positions so they are relative to the complete text, not just to the sentence.
    
    Parameters:
    charCount - Count of characters in the sentences before
    columnCount - Current column number
    lineCount - Current line number
    sentence - The text being checked
    
    Returns:
    The RuleMatch object with adjustments.
  - rememberUnknownWords
```
protected void rememberUnknownWords(AnalyzedSentence analyzedText)
```
  - getUnknownWords
```
public List<String> getUnknownWords()
```
    Get the alphabetically sorted list of unknown words in the latest run of one of the check(String) methods.
    
    Throws:
    
    IllegalStateException - if setListUnknownWords(boolean) has been set to false
  - getAnalyzedSentence
```
public AnalyzedSentence getAnalyzedSentence(String sentence)
                                     throws IOException
```
    Tokenizes the given sentence into words and analyzes it, and then disambiguates POS tags.
    
    Parameters:
    sentence - sentence to be analyzed
    
    Throws:
    
    IOException
  - getRawAnalyzedSentence
```
public AnalyzedSentence getRawAnalyzedSentence(String sentence)
                                        throws IOException
```
    Tokenizes the given sentence into words and analyzes it. This is the same as getAnalyzedSentence(String) but it does not run the disambiguator.
    
    Parameters:
    sentence - sentence to be analyzed
    
    Throws:
    
    IOException
    Since:
    
    0.9.8
  - getAllRules
```
public List<Rule> getAllRules()
```
    Get all rules for the current language that are built-in or that have been added using addRule(Rule).
    
    Returns:
    a List of Rule objects
  - getAllActiveRules
```
public List<Rule> getAllActiveRules()
```
    Get all active (not disabled) rules for the current language that are built-in or that have been added using e.g. addRule(Rule).
    
    Returns:
    a List of Rule objects
  - getPatternRulesByIdAndSubId
```
public List<PatternRule> getPatternRulesByIdAndSubId(String Id,
                                            String subId)
```
    Get pattern rules by Id and SubId. This returns a list because rules that use <or>...</or> are internally expanded into several rules.
    
    Returns:
    a List of Rule objects
    Since:
    
    2.3
  - getSentenceCount
```
public int getSentenceCount()
```
    Deprecated. use analyzeText(String) instead (deprecated since 2.7)
    
    Number of sentences the latest call to a check method like check(String) has checked.
  - printIfVerbose
```
protected void printIfVerbose(String s)
```
  - addTemporaryFile
```
public static void addTemporaryFile(File file)
```
    Adds a temporary file to the internal list (internal method, you should never need to call this as a user of LanguageTool)
    
    Parameters:
    file - the file to be added.
  - removeTemporaryFiles
```
public static void removeTemporaryFiles()
```
    Clean up all temporary files, if there are any.

Class JLanguageTool

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

BUILD_DATE

PATTERN_FILE

FALSE_FRIEND_FILE

SENTENCE_START_TAGNAME

SENTENCE_END_TAGNAME

PARAGRAPH_END_TAGNAME

MESSAGE_BUNDLE

Constructor Detail

JLanguageTool

JLanguageTool

Method Detail

getDataBroker

setDataBroker

setListUnknownWords

getMessageBundle

getMessageBundle

setOutput

loadPatternRules

loadFalseFriendRules

activateLanguageModelRules

addRule

disableRule

disableRules

disableCategory

getLanguage

getDisabledRules

enableDefaultOffRule

getDisabledCategories

enableRule

sentenceTokenize

check

check

check

check

analyzeText

analyzeSentences

printSentenceInfo

performCheck

checkAnalyzedSentence

checkAnalyzedSentence

adjustRuleMatchPos

rememberUnknownWords

getUnknownWords

getAnalyzedSentence

getRawAnalyzedSentence

getAllRules

getAllActiveRules

getPatternRulesByIdAndSubId

getSentenceCount

printIfVerbose

addTemporaryFile

removeTemporaryFiles