org.languagetool.rules.patterns.bitext

Class BitextPatternRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.bitext.BitextRule

org.languagetool.rules.patterns.bitext.BitextPatternRule

public class BitextPatternRule
extends BitextRule

A bitext pattern rule class. A BitextPatternRule describes a language error and can test whether a given pre-analyzed pair of source and target text contains that error using the Rule.match(org.languagetool.AnalyzedSentence) method. It uses the syntax of XML files similar to normal PatternRules.

Author:

Marcin Miłkowski

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
String	getId() A string used to identify the rule in e.g. configuration files.
String	getMessage()
PatternRule	getSrcRule()
PatternRule	getTrgRule()
RuleMatch[]	match(AnalyzedSentence sentence) This method always returns an empty array.
RuleMatch[]	match(AnalyzedSentence sourceSentence, AnalyzedSentence targetSentence)
void	reset() If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset.

Methods inherited from class org.languagetool.rules.bitext.BitextRule

getCorrectBitextExamples, getIncorrectBitextExamples, getPureText, getRelevantRules, getSourceLanguage, setCorrectBitextExamples, setIncorrectBitextExamples, setSourceLanguage

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, getCategory, getCorrectExamples, getIncorrectExamples, getLocQualityIssueType, getUrl, isDefaultOff, isDictionaryBasedSpellingRule, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setIncorrectExamples, setLocQualityIssueType, setUrl, supportsLanguage, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Method Detail

getSrcRule

public PatternRule getSrcRule()

getTrgRule

public PatternRule getTrgRule()

getDescription

public String getDescription()

Description copied from class: Rule

A short description of the error this rule can detect, usually in the language of the text that is checked.

Specified by:

getDescription in class BitextRule

getMessage

public String getMessage()

Specified by:

getMessage in class BitextRule

getId

public String getId()

Description copied from class: Rule

A string used to identify the rule in e.g. configuration files. This string is supposed to be unique and to stay the same in all upcoming versions of LanguageTool. It's supposed to contain only the characters A-Z and the underscore.

Specified by:

getId in class BitextRule

match

public RuleMatch[] match(AnalyzedSentence sentence)
                  throws IOException

This method always returns an empty array. Use match(org.languagetool.AnalyzedSentence, org.languagetool.AnalyzedSentence) instead.

Overrides:

match in class BitextRule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

match

public RuleMatch[] match(AnalyzedSentence sourceSentence,
                AnalyzedSentence targetSentence)
                  throws IOException

Specified by:

match in class BitextRule

Throws:

IOException

reset

public void reset()

Description copied from class: Rule

If a rule keeps its state over more than the check of one sentence, this must be implemented so the internal state is reset. It will be called before a new text is going to be checked.

Specified by:

reset in class BitextRule