org.languagetool.rules.patterns

Class Match

java.lang.Object

org.languagetool.rules.patterns.Match

public final class Match
extends Object

A Match is the configuration of an algorithm used to match AnalyzedTokenReadingss. In XML, it's the <match/> element. Use createState(Synthesizer, AnalyzedTokenReadings) and createState(Synthesizer, AnalyzedTokenReadings[], int, int) to create a MatchState used to actually match AnalyzedTokenReadings.

Author:

Marcin Miłkowski

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Match.CaseConversion Possible string case conversions.
static class	Match.IncludeRange

Constructor Summary

Constructors

Constructor and Description
Match(String posTag, String posTagReplace, boolean postagRegexp, String regexMatch, String regexReplace, Match.CaseConversion caseConversionType, boolean setPOS, boolean suppressMisspelled, Match.IncludeRange includeSkipped)

Method Summary

Modifier and Type	Method and Description
boolean	checksSpelling() Used to tell whether the Match class will spell-check the result so that misspelled suggestions are suppressed.
boolean	convertsCase() Used to let LT know that it should change the case of the match.
MatchState	createState(Synthesizer synthesizer, AnalyzedTokenReadings token) Creates a state used for actually matching a token.
MatchState	createState(Synthesizer synthesizer, AnalyzedTokenReadings[] tokens, int index, int next) Creates a state used for actually matching a token.
Match.CaseConversion	getCaseConversionType()
Match.IncludeRange	getIncludeSkipped()
String	getLemma()
Pattern	getPosRegexMatch()
String	getPosTag()
String	getPosTagReplace()
Pattern	getRegexMatch()
String	getRegexReplace()
int	getTokenRef() Gets the token number referenced by the match.
boolean	isInMessageOnly()
boolean	isPostagRegexp()
boolean	isStaticLemma()
boolean	posRegExp() Checks if the Match element uses regexp-based form of the POS tag.
void	setInMessageOnly(boolean inMessageOnly)
void	setLemmaString(String lemmaString) Sets a base form (lemma) that will be formatted, or synthesized, using the specified POS regular expressions.
boolean	setsPos() Checks if the Match element is used for setting the part of speech: setpos="yes" in XML.
void	setTokenRef(int i) Sets the token number referenced by the match.

Methods inherited from class java.lang.Object

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

Constructor Detail

Match

public Match(String posTag,
             String posTagReplace,
             boolean postagRegexp,
             String regexMatch,
             String regexReplace,
             Match.CaseConversion caseConversionType,
             boolean setPOS,
             boolean suppressMisspelled,
             Match.IncludeRange includeSkipped)

Method Detail

createState

public MatchState createState(Synthesizer synthesizer,
                              AnalyzedTokenReadings token)

Creates a state used for actually matching a token.

Since:

2.3

createState

public MatchState createState(Synthesizer synthesizer,
                              AnalyzedTokenReadings[] tokens,
                              int index,
                              int next)

Creates a state used for actually matching a token.

Since:

2.3

setsPos

public boolean setsPos()

Checks if the Match element is used for setting the part of speech: setpos="yes" in XML.

Returns:

True if Match sets POS.

posRegExp

public boolean posRegExp()

Checks if the Match element uses regexp-based form of the POS tag.

Returns:

True if regexp is used in POS.

setLemmaString

public void setLemmaString(String lemmaString)

Sets a base form (lemma) that will be formatted, or synthesized, using the specified POS regular expressions.

Parameters:

lemmaString - String that specifies the base form.

getLemma

public String getLemma()

Since:

2.3

isStaticLemma

public boolean isStaticLemma()

Since:

2.3

checksSpelling

public boolean checksSpelling()

Used to tell whether the Match class will spell-check the result so that misspelled suggestions are suppressed.

Returns:

True if this is so.

setTokenRef

public void setTokenRef(int i)

Sets the token number referenced by the match.

Parameters:

i - Token number.

getTokenRef

public int getTokenRef()

Gets the token number referenced by the match.

Returns:

token number.

convertsCase

public boolean convertsCase()

Used to let LT know that it should change the case of the match.

Returns:

true if match converts the case of the token.

getCaseConversionType

public Match.CaseConversion getCaseConversionType()

Since:

2.3

setInMessageOnly

public void setInMessageOnly(boolean inMessageOnly)

isInMessageOnly

public boolean isInMessageOnly()

getPosTag

public String getPosTag()

Since:

2.3

getRegexMatch

public Pattern getRegexMatch()

Since:

2.3

getRegexReplace

public String getRegexReplace()

Since:

2.3

getPosRegexMatch

public Pattern getPosRegexMatch()

Since:

2.3

isPostagRegexp

public boolean isPostagRegexp()

Since:

2.3

getPosTagReplace

public String getPosTagReplace()

Since:

2.3

getIncludeSkipped

public Match.IncludeRange getIncludeSkipped()

Since:

2.3