Class AbstractStyleRepeatedWordRule


  • public abstract class AbstractStyleRepeatedWordRule
    extends TextLevelRule
    An abstract rule checks the appearance of same words in a sentence or in two consecutive sentences. The isTokenToCheck method can be used to check only specific words (e.g. substantive, verbs and adjectives). This rule detects no grammar error but a stylistic problem (default off)
    Since:
    4.1
    • Field Detail

      • maxDistanceOfSentences

        protected int maxDistanceOfSentences
    • Constructor Detail

      • AbstractStyleRepeatedWordRule

        public AbstractStyleRepeatedWordRule​(java.util.ResourceBundle messages,
                                             Language lang,
                                             UserConfig userConfig)
    • Method Detail

      • getId

        public java.lang.String getId()
        Override this ID by adding a language acronym (e.g. STYLE_REPEATED_WORD_RULE_DE) to use adjustment of maxWords by option panel
        Specified by:
        getId in class Rule
        Since:
        4.1
      • getDescription

        public java.lang.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
      • messageSameSentence

        protected abstract java.lang.String messageSameSentence()
      • messageSentenceBefore

        protected abstract java.lang.String messageSentenceBefore()
      • messageSentenceAfter

        protected abstract java.lang.String messageSentenceAfter()
      • 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
        Since:
        4.2
      • getMinConfigurableValue

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

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

        public java.lang.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
        Since:
        4.2
      • isTokenPair

        protected abstract boolean isTokenPair​(AnalyzedTokenReadings[] tokens,
                                               int n,
                                               boolean before)
      • isPartOfWord

        protected boolean isPartOfWord​(java.lang.String testTokenText,
                                       java.lang.String tokenText)
      • setURL

        protected java.net.URL setURL​(AnalyzedTokenReadings token)
                               throws java.net.MalformedURLException
        Throws:
        java.net.MalformedURLException
      • getSynonyms

        public java.util.List<java.lang.String> getSynonyms​(AnalyzedTokenReadings token)
        get synonyms for a repeated word
      • 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