Package 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.

  • Field Details

    • posTag

      private final String posTag

    • suppressMisspelled

      private final boolean suppressMisspelled

    • regexReplace

      private final String regexReplace

    • posTagReplace

      private final String posTagReplace

    • caseConversionType

      private final Match.CaseConversion caseConversionType

    • includeSkipped

      private final Match.IncludeRange includeSkipped

    • pRegexMatch

      private final Pattern pRegexMatch

    • setPos

      private final boolean setPos

    • postagRegexp

      private boolean postagRegexp

    • staticLemma

      private boolean staticLemma

    • lemma

      private String lemma

    • tokenRef

      private int tokenRef

    • pPosRegexMatch

      private Pattern pPosRegexMatch

    • inMessageOnly

      private boolean inMessageOnly

  • Constructor Details

  • Method Details

    • 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