org.languagetool.rules.bitext

Class BitextRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.bitext.BitextRule

Direct Known Subclasses:

BitextPatternRule, DifferentLengthRule, DifferentPunctuationRule, SameTranslationRule

public abstract class BitextRule
extends Rule

Abstract bitext rule class. A BitextRule 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.

Author:

Marcin Miłkowski

Field Summary

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor and Description
BitextRule()

Method Summary

Methods

Modifier and Type	Method and Description
List<StringPair>	getCorrectBitextExamples() Get example sentences that are correct and thus will not match this rule.
abstract String	getDescription() A short description of the error this rule can detect, usually in the language of the text that is checked.
abstract String	getId() A string used to identify the rule in e.g. configuration files.
List<IncorrectBitextExample>	getIncorrectBitextExamples() Get example sentences that are incorrect and thus will match this rule.
abstract String	getMessage()
protected String	getPureText(AnalyzedSentence sentence)
static List<Class<? extends BitextRule>>	getRelevantRules()
Language	getSourceLanguage()
RuleMatch[]	match(AnalyzedSentence sentence) This method makes no sense for bitext, thus it always returns null.
abstract RuleMatch[]	match(AnalyzedSentence sourceText, AnalyzedSentence targetText)
abstract 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.
void	setCorrectBitextExamples(List<StringPair> correctExamples) Set the examples that are correct and thus do not trigger the rule.
void	setIncorrectBitextExamples(List<IncorrectBitextExample> incorrectExamples) Set the examples that are incorrect and thus do trigger the rule.
void	setSourceLanguage(Language lang) Set the source language.

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

Constructor Detail

BitextRule

public BitextRule()

Method Detail

getRelevantRules

public static List<Class<? extends BitextRule>> getRelevantRules()

getDescription

public abstract 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 Rule

getId

public abstract 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 Rule

reset

public abstract 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 Rule

getMessage

public abstract String getMessage()

match

public abstract RuleMatch[] match(AnalyzedSentence sourceText,
                AnalyzedSentence targetText)
                           throws IOException

Throws:

IOException

match

@Nullable
public RuleMatch[] match(AnalyzedSentence sentence)
                  throws IOException

This method makes no sense for bitext, thus it always returns null.

Specified by:

match in class Rule

Parameters:

sentence - a pre-analyzed sentence

Returns:

an array of RuleMatch objects

Throws:

IOException

setSourceLanguage

public final void setSourceLanguage(Language lang)

Set the source language. If the language is not supported by LT, you need to use the default tokenizers etc.

Parameters:

lang - Source Language

getSourceLanguage

public final Language getSourceLanguage()

setCorrectBitextExamples

public final void setCorrectBitextExamples(List<StringPair> correctExamples)

Set the examples that are correct and thus do not trigger the rule.

getCorrectBitextExamples

public final List<StringPair> getCorrectBitextExamples()

Get example sentences that are correct and thus will not match this rule.

setIncorrectBitextExamples

public final void setIncorrectBitextExamples(List<IncorrectBitextExample> incorrectExamples)

Set the examples that are incorrect and thus do trigger the rule.

getIncorrectBitextExamples

public final List<IncorrectBitextExample> getIncorrectBitextExamples()

Get example sentences that are incorrect and thus will match this rule.

getPureText

protected String getPureText(AnalyzedSentence sentence)