Class MatchState

java.lang.Object
org.languagetool.rules.patterns.MatchState

public class MatchState extends Object
The state of a matching process. This state is NOT thread-safe.
Since:
2.3
  • Field Details

  • Constructor Details

  • Method Details

    • setToken

      public void setToken(AnalyzedTokenReadings token)
    • setToken

      public final void setToken(AnalyzedTokenReadings[] tokens, int index, int next)
      Sets the token to be formatted etc. and includes the support for including the skipped tokens.
      Parameters:
      tokens - Array of tokens
      index - Index of the token to be formatted
      next - Position of the next token (the skipped tokens are the ones between the tokens[index] and tokens[next]
    • filterReadings

      public final AnalyzedTokenReadings filterReadings()
    • convertCase

      String convertCase(String s, String sample, Language lang)
      Converts case of the string token according to match element attributes.
      Parameters:
      s - Token to be converted.
      sample - the sample string used to determine how the original string looks like (used only on case preservation)
      Returns:
      Converted string.
    • getNewToken

      private List<AnalyzedToken> getNewToken(int numRead, String token)
    • toFinalString

      public final String[] toFinalString(Language lang) throws IOException
      Gets all strings formatted using the match element.
      Throws:
      IOException
    • getTargetPosTag

      public final String getTargetPosTag()
      Format POS tag using parameters already defined in the class.
      Returns:
      Formatted POS tag as String.
    • toTokenString

      final String toTokenString() throws IOException
      Method for getting the formatted match as a single string. In case of multiple matches, it joins them using a regular expression operator "|".
      Returns:
      Formatted string of the matched token.
      Throws:
      IOException
    • getMatch

      public Match getMatch()