Class AbstractFillerWordsRule


public abstract class AbstractFillerWordsRule extends TextLevelRule
A rule that gives hints about the use of filler words. The hints are only given when the percentage of filler words per paragraph exceeds the given limit. A limit of 0 shows all used filler words. Direct speech or citation is excluded otherwise. This rule detects no grammar error but gives stylistic hints (default off).
Since:
4.2
  • Field Details

    • RULE_ID

      public static final String RULE_ID
      See Also:
    • DEFAULT_MIN_PERCENT

      private static final int DEFAULT_MIN_PERCENT
      See Also:
    • OPENING_QUOTES

      private static final Pattern OPENING_QUOTES
    • ENDING_QUOTES

      private static final Pattern ENDING_QUOTES
    • DEFAULT_ACTIVATION

      private static final boolean DEFAULT_ACTIVATION
      See Also:
    • minPercent

      private int minPercent
    • lang

      private final Language lang
  • Constructor Details

  • Method Details

    • isFillerWord

      protected abstract boolean isFillerWord(String token)
    • getDescription

      public String getDescription()
      Description copied from class: Rule
      A short description of the error this rule can detect, usually in the language of the text that is checked.
      Specified by:
      getDescription in class Rule
    • getId

      public String getId()
      Description copied from class: Rule
      A 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. It's supposed to contain only the characters A-Z and the underscore.
      Specified by:
      getId in class Rule
    • getDefaultValue

      public int getDefaultValue()
      Description copied from class: Rule
      Overwrite this to get a default Integer value by option panel
      Overrides:
      getDefaultValue in class Rule
    • hasConfigurableValue

      public boolean hasConfigurableValue()
      Description copied from class: Rule
      Overwrite this to return true, if a value may be configured by option panel
      Overrides:
      hasConfigurableValue in class Rule
    • getMinConfigurableValue

      public int getMinConfigurableValue()
      Description copied from class: Rule
      Overwrite this to define the minimum of a configurable value
      Overrides:
      getMinConfigurableValue in class Rule
    • getMaxConfigurableValue

      public int getMaxConfigurableValue()
      Description copied from class: Rule
      Overwrite this to define the maximum of a configurable value
      Overrides:
      getMaxConfigurableValue in class Rule
    • getConfigureText

      public String getConfigureText()
      Description copied from class: Rule
      Overwrite this to define the Text in the option panel for the configurable value
      Overrides:
      getConfigureText in class Rule
    • getMessage

      public String getMessage()
    • isException

      protected boolean isException(AnalyzedTokenReadings[] tokens, int num)
    • match

      public RuleMatch[] match(List<AnalyzedSentence> sentences) throws IOException
      Specified by:
      match in class TextLevelRule
      Throws:
      IOException
    • minToCheckParagraph

      public int minToCheckParagraph()
      Description copied from class: TextLevelRule
      Gives back the minimum number of paragraphs to check to give back a correct result. Only used by LO office extension.
      • n == -1 --> need to check full text (use only if really needed / bad performance) examples: AbstractWordCoherencyRule, GenericUnpairedBracketsRule, ...
      • n == 0 --> need only to check the current paragraph examples: MultipleWhitespaceRule, LongParagraphRule, ...
      • n >= 1 --> need only to check n paragraphs around the current paragraph examples: ParagraphRepeatBeginningRule (n == 1), WordRepeatBeginningRule (n == 2), ...
      Specified by:
      minToCheckParagraph in class TextLevelRule