org.languagetool
Class JLanguageTool

Object
  JLanguageTool

public final class JLanguageTool
extends Object

The main class used for checking text against different rules:

• the built-in rules (a vs. an, whitespace after commas, ...)
• pattern rules loaded from external XML files with loadPatternRules(String)
• your own implementation of the abstract Rule classes added with addRule(Rule)

Note that the constructors create a language checker that uses the built-in rules only. Other rules (e.g. from XML) need to be added explicitly.

Author:

Daniel Naber

Nested Class Summary

static class

JLanguageTool.ParagraphHandling Constants for correct paragraph-rule handling.

Field Summary

static String	BUILD_DATE
static String	FALSE_FRIEND_FILE
static String	PARAGRAPH_END_TAGNAME
static String	PATTERN_FILE
static String	SENTENCE_END_TAGNAME
static String	SENTENCE_START_TAGNAME
static String	VERSION

Constructor Summary

JLanguageTool(Language language)
Create a JLanguageTool and setup the built-in rules appropriate for the given language, ignoring false friend hints.

JLanguageTool(Language language, Language motherTongue)
Create a JLanguageTool and setup the built-in rules appropriate for the given language.

Method Summary

void	activateDefaultFalseFriendRules() Loads and activates the false friend rules from rules/false-friends.xml.
void	activateDefaultPatternRules() Loads and activates the pattern rules from rules/<language>/grammar.xml.
void	addRule(Rule rule) Add a rule to be used by the next call to check(String).
RuleMatch	adjustRuleMatchPos(RuleMatch rm, int sentLen, int columnCount, int lineCount, String sentence) Change RuleMatch positions so they are relative to the complete text, not just to the sentence:
List<RuleMatch>	check(String text) The main check method.
List<RuleMatch>	check(String text, boolean tokenizeText, JLanguageTool.ParagraphHandling paraMode) The main check method.
List<RuleMatch>	checkAnalyzedSentence(JLanguageTool.ParagraphHandling paraMode, List<Rule> allRules, int tokenCount, int lineCount, int columnCount, String sentence, AnalyzedSentence analyzedText)
void	disableCategory(String categoryName) Disable a given category so check(String) won't use it.
void	disableRule(String ruleId) Disable a given rule so check(String) won't use it.
void	enableDefaultOffRule(String ruleId) Enable a rule that was switched off by default.
void	enableRule(String ruleId) Re-enable a given rule so check(String) will use it.
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 rules 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 for the default language of the user's system.
AnalyzedSentence	getRawAnalyzedSentence(String sentence) Tokenizes the given sentence into words and analyzes it.
int	getSentenceCount() Number of sentences the latest call to check() has checked.
List<String>	getUnknownWords() Get the list of unknown words in the last run of the check() method.
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.
List<String>	sentenceTokenize(String text) Returns tokenized 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() method stores unknown words.
void	setOutput(PrintStream printStream) Set a PrintStream that will receive verbose output.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

BUILD_DATE

public static final String BUILD_DATE

PATTERN_FILE

public static final String PATTERN_FILE

See Also:

Constant Field Values

FALSE_FRIEND_FILE

public static final String FALSE_FRIEND_FILE

See Also:

Constant Field Values

SENTENCE_START_TAGNAME

public static final String SENTENCE_START_TAGNAME

See Also:

Constant Field Values

SENTENCE_END_TAGNAME

public static final String SENTENCE_END_TAGNAME

See Also:

Constant Field Values

PARAGRAPH_END_TAGNAME

public static final String PARAGRAPH_END_TAGNAME

See Also:

Constant Field Values

Constructor Detail

JLanguageTool

public JLanguageTool(Language language)
              throws IOException

Create a JLanguageTool and setup the built-in rules appropriate for the given language, ignoring false friend hints.

Throws:

IOException

JLanguageTool

public JLanguageTool(Language language,
                     Language motherTongue)
              throws IOException

Create a JLanguageTool and setup the built-in rules appropriate for the given language.

Parameters:

language - the language to be used.

motherTongue - the user's mother tongue or null. The mother tongue may also be used as a source language for checking bilingual texts.

Throws:

IOException

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() method stores 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 for the default language of the user's system.

setOutput

public void setOutput(PrintStream printStream)

Set a PrintStream that will receive verbose output. Set to null 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.

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.

Returns:

a List of PatternRule objects

Throws:

ParserConfigurationException

SAXException

IOException

activateDefaultPatternRules

public void activateDefaultPatternRules()
                                 throws IOException

Loads and activates the pattern rules from rules/<language>/grammar.xml.

Throws:

ParserConfigurationException

SAXException

IOException

activateDefaultFalseFriendRules

public void activateDefaultFalseFriendRules()
                                     throws ParserConfigurationException,
                                            SAXException,
                                            IOException

Loads and activates the false friend rules from rules/false-friends.xml.

Throws:

ParserConfigurationException

SAXException

IOException

addRule

public void addRule(Rule rule)

Add a rule to be used by the next call to check(String).

disableRule

public void disableRule(String ruleId)

Disable a given rule so check(String) won't use it.

Parameters:

ruleId - the id of the rule to disable

disableCategory

public void disableCategory(String categoryName)

Disable a given category so check(String) won't use it.

Parameters:

categoryName - the id of the category to disable

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 was switched off by default.

Parameters:

ruleId - the id of the turned off rule to enable.

getDisabledCategories

public Set<String> getDisabledCategories()

Get category ids of the rules that have been explicitly disabled.

enableRule

public void enableRule(String ruleId)

Re-enable a given rule so check(String) will use it.

Parameters:

ruleId - the id of the rule to enable

sentenceTokenize

public List<String> sentenceTokenize(String text)

Returns tokenized 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 check

Returns:

a List of RuleMatch objects

Throws:

IOException

check

public List<RuleMatch> check(String text,
                             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:

text - The text to check. Call this method with the complete text to check. If you call it with smaller chunks like paragraphs or sentence, those rules that work across paragraphs/sentences won't work (their status gets reset whenever this).

tokenizeText - If true, then the text is tokenized into sentences. Otherwise, it is assumed it's already tokenized.

paraMode - Uses paragraph-level rules only if true.

Returns:

a List of RuleMatch objects

Throws:

IOException

checkAnalyzedSentence

public List<RuleMatch> checkAnalyzedSentence(JLanguageTool.ParagraphHandling paraMode,
                                             List<Rule> allRules,
                                             int tokenCount,
                                             int lineCount,
                                             int columnCount,
                                             String sentence,
                                             AnalyzedSentence analyzedText)
                                      throws IOException

Throws:

IOException

adjustRuleMatchPos

public RuleMatch adjustRuleMatchPos(RuleMatch rm,
                                    int sentLen,
                                    int columnCount,
                                    int lineCount,
                                    String sentence)

Change RuleMatch positions so they are relative to the complete text, not just to the sentence:

Parameters:

rm - RuleMatch

sentLen - Count of characters

columnCount - Current column number

lineCount - Current line number

sentence - The text being checked

Returns:

The RuleMatch object with adjustments.

getUnknownWords

public List<String> getUnknownWords()

Get the list of unknown words in the last run of the check() method.

Throws:

IllegalStateException - if listUnknownWords is 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.

Throws:

IOException

getRawAnalyzedSentence

public AnalyzedSentence getRawAnalyzedSentence(String sentence)
                                        throws IOException

Tokenizes the given sentence into words and analyzes it.

Parameters:

sentence - Sentence to be analyzed

Returns:

AnalyzedSentence

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

getSentenceCount

public int getSentenceCount()

Number of sentences the latest call to check() has checked.