Package org.languagetool.tagging.disambiguation.rules

Class DisambiguationPatternRule

java.lang.Object

org.languagetool.rules.Rule

org.languagetool.rules.patterns.AbstractPatternRule

org.languagetool.rules.patterns.AbstractTokenBasedRule

org.languagetool.tagging.disambiguation.rules.DisambiguationPatternRule

public class DisambiguationPatternRule
extends AbstractTokenBasedRule

A Rule that describes a pattern of words or part-of-speech tags used for disambiguation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DisambiguationPatternRule.DisambiguatorAction	Possible disambiguator actions.

Field Summary

Fields

Modifier and Type	Field	Description
private final DisambiguationPatternRule.DisambiguatorAction	disAction
private final String	disambiguatedPOS
private List<DisambiguatedExample>	examples
private final Match	matchElement
private AnalyzedToken[]	newTokenReadings
private List<String>	untouchedExamples

Fields inherited from class org.languagetool.rules.patterns.AbstractPatternRule

antiPatterns, endPositionCorrection, filter, filterArgs, language, message, patternTokens, sentStart, sourceFile, startPositionCorrection, subId, suggestionMatches, suggestionMatchesOutMsg, suggestionsOutMsg, testUnification, type

Fields inherited from class org.languagetool.rules.Rule

messages

Constructor Summary

Constructors

Constructor	Description
DisambiguationPatternRule(String id, String description, Language language, List<PatternToken> patternTokens, String disambiguatedPOS, Match posSelect, DisambiguationPatternRule.DisambiguatorAction disambAction)

Method Summary

Modifier and Type	Method	Description
DisambiguationPatternRule.DisambiguatorAction	getAction()
String	getDisambiguatedPOS()
List<DisambiguatedExample>	getExamples()
Match	getMatchElement()
AnalyzedToken[]	getNewTokenReadings()
List<String>	getUntouchedExamples()
final AnalyzedSentence	replace(AnalyzedSentence sentence)	Performs disambiguation on the source sentence.
void	setExamples(List<DisambiguatedExample> examples)
final void	setNewInterpretations(AnalyzedToken[] newReadings)	Used to add new interpretations.
void	setUntouchedExamples(List<String> untouchedExamples)

Methods inherited from class org.languagetool.rules.patterns.AbstractTokenBasedRule

canBeIgnoredFor

Methods inherited from class org.languagetool.rules.patterns.AbstractPatternRule

addSuggestionMatch, addSuggestionMatchOutMsg, getAntiPatterns, getDescription, getEndPositionCorrection, getFilter, getFilterArguments, getFullId, getId, getLanguage, getMessage, getPatternRuleId, getPatternTokens, getSourceFile, getStartPositionCorrection, getSubId, getSuggestionMatches, getSuggestionsOutMsg, getType, getXmlLineNumber, isAdjustSuggestionCase, isGetUnified, isGroupsOrUnification, isSentStart, isTestUnification, match, setAdjustSuggestionCase, setAntiPatterns, setEndPositionCorrection, setFilter, setFilterArguments, setMessage, setStartPositionCorrection, setSubId, setType, setXmlLineNumber, supportsLanguage, toString

Methods inherited from class org.languagetool.rules.Rule

addExamplePair, addTags, addToneTags, cacheAntiPatterns, estimateContextForSureMatch, getCategory, getCorrectExamples, getDistanceTokens, getErrorTriggeringExamples, getIncorrectExamples, getLocQualityIssueType, getMinPrevMatches, getPriority, getRuleOptions, getSentenceWithImmunization, getTags, getToneTags, getUrl, hasTag, hasToneTag, isDefaultOff, isDefaultTempOff, isDictionaryBasedSpellingRule, isGoalSpecific, isIncludedInHiddenMatches, isOfficeDefaultOff, isOfficeDefaultOn, isPremium, makeAntiPatterns, setCategory, setCorrectExamples, setDefaultOff, setDefaultOn, setDefaultTempOff, setDistanceTokens, setErrorTriggeringExamples, setExamplePair, setGoalSpecific, setIncludedInHiddenMatches, setIncorrectExamples, setLocQualityIssueType, setMinPrevMatches, setOfficeDefaultOff, setOfficeDefaultOn, setPremium, setPriority, setTags, setToneTags, setUrl, toRuleMatchArray, useInOffice

Methods inherited from class java.lang.Object

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

Field Details

disambiguatedPOS

private final String disambiguatedPOS

matchElement

private final Match matchElement

disAction

private final DisambiguationPatternRule.DisambiguatorAction disAction

newTokenReadings

private AnalyzedToken[] newTokenReadings

examples

private List<DisambiguatedExample> examples

untouchedExamples

private List<String> untouchedExamples

Constructor Details

DisambiguationPatternRule

public DisambiguationPatternRule(String id,
 String description,
 Language language,
 List<PatternToken> patternTokens,
 String disambiguatedPOS,
 Match posSelect,
 DisambiguationPatternRule.DisambiguatorAction disambAction)

Parameters:

id - Id of the Rule

description - Description to be shown (name)

language - Language of the Rule

disambAction - the action to be executed on found token(s)

Since:

public since 2.5

Method Details

setNewInterpretations

public final void setNewInterpretations(AnalyzedToken[] newReadings)

Used to add new interpretations.

Parameters:

newReadings - An array of AnalyzedTokens. The length of the array should be the same as the number of the tokens matched and selected by <marker>...</marker> elements.

replace

public final AnalyzedSentence replace(AnalyzedSentence sentence)
                               throws IOException

Performs disambiguation on the source sentence.

Parameters:

sentence - AnalyzedSentence Sentence to be disambiguated.

Returns:

AnalyzedSentence Disambiguated sentence (might be unchanged).

Throws:

IOException

setExamples

public void setExamples(List<DisambiguatedExample> examples)

getExamples

public List<DisambiguatedExample> getExamples()

setUntouchedExamples

public void setUntouchedExamples(List<String> untouchedExamples)

getUntouchedExamples

public List<String> getUntouchedExamples()

getAction

public DisambiguationPatternRule.DisambiguatorAction getAction()

Since:

2.3

getNewTokenReadings

public AnalyzedToken[] getNewTokenReadings()

Since:

2.3

getMatchElement

@Nullable
public Match getMatchElement()

Since:

2.3

getDisambiguatedPOS

@Nullable
public String getDisambiguatedPOS()

Since:

2.3