org.languagetool.rules.patterns.bitext

Class BitextPatternRule

Object

Rule

BitextRule

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription()
String	getId() An ASCII-only string used to identify the rule in e.g. configuration files.
String	getMessage()
PatternRule	getSrcRule()
PatternRule	getTrgRule()
RuleMatch[]	match(AnalyzedSentence text) This method always returns an empty array.
RuleMatch[]	match(AnalyzedSentence sourceText, AnalyzedSentence targetText)
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 BitextRule

getCorrectBitextExamples, getIncorrectBitextExamples, getRelevantRules, getSourceLang, setCorrectBitextExamples, setIncorrectBitextExamples, setSourceLang

Methods inherited from class Rule

addRuleMatch, clearMatches, getCategory, getCorrectExamples, getIncorrectExamples, getMatches, getMatchesIndex, isDefaultOff, isInMatches, isInRemoved, isParagraphBackTrack, setAsDeleted, setCategory, setCorrectExamples, setDefaultOff, setIncorrectExamples, setParagraphBackTrack, supportsLanguage

Methods inherited from class Object

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

Method Detail

getSrcRule

public PatternRule getSrcRule()

getTrgRule

public PatternRule getTrgRule()

getDescription

public String getDescription()

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

An ASCII-only 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.

Specified by:

getId in class BitextRule

match

public RuleMatch[] match(AnalyzedSentence text)
                  throws IOException

This method always returns an empty array.

Overrides:

match in class BitextRule

Parameters:

text - a pre-analyzed sentence

Returns:

an array of RuleMatch object for each match.

Throws:

IOException

match

public RuleMatch[] match(AnalyzedSentence sourceText,
                AnalyzedSentence targetText)
                  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