Package org.languagetool.rules.patterns

Class RuleSet

java.lang.Object

org.languagetool.rules.patterns.RuleSet

@Internal
public abstract class RuleSet
extends Object

An object holding a set of rules with an optional possibility to fetch only the ones applicable for a given sentence (via rulesForSentence(org.languagetool.AnalyzedSentence)), to avoid even invoking the definitely inapplicable ones. The filtering is based on cues provided by the rules, e.g. possible token strings or lemmas in pattern rules.

Since:

5.2

Field Summary

Fields

Modifier and Type	Field	Description
private Set<String>	ruleIds

Constructor Summary

Constructors

Constructor	Description
RuleSet()

Method Summary

Modifier and Type	Method	Description
Set<String>	allRuleIds()
abstract List<Rule>	allRules()
static <T> List<T>	filterList(BitSet includedIndices, List<T> list)
private static RuleSet	hinted(List<? extends Rule> rules, boolean withLemmaHints)
static RuleSet	plain(List<Rule> rules)
abstract List<Rule>	rulesForSentence(AnalyzedSentence sentence)
static RuleSet	textHinted(List<? extends Rule> rules)
static RuleSet	textLemmaHinted(List<? extends Rule> rules)

Methods inherited from class java.lang.Object

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

Field Details

ruleIds

private volatile Set<String> ruleIds

Constructor Details

RuleSet

public RuleSet()

Method Details

allRules

public abstract List<Rule> allRules()

Returns:

all rules in this set, not filtered

rulesForSentence

public abstract List<Rule> rulesForSentence(AnalyzedSentence sentence)

Returns:

all rules from allRules() that might be applicable to the given sentence.

allRuleIds

public Set<String> allRuleIds()

Returns:

the ids of allRules()

Since:

5.6

plain

public static RuleSet plain(List<Rule> rules)

Returns:

a simple RuleSet that returns all the rules from rulesForSentence(org.languagetool.AnalyzedSentence)

textLemmaHinted

public static RuleSet textLemmaHinted(List<? extends Rule> rules)

Returns:

a RuleSet whose rulesForSentence(org.languagetool.AnalyzedSentence) excludes rules requiring token texts or lemmas that don't occur in the given sentence

textHinted

public static RuleSet textHinted(List<? extends Rule> rules)

Returns:

a RuleSet whose rulesForSentence(org.languagetool.AnalyzedSentence) excludes rules requiring token texts that don't occur in the given sentence.

hinted

private static RuleSet hinted(List<? extends Rule> rules,
 boolean withLemmaHints)

filterList

@Internal
public static <T> List<T> filterList(BitSet includedIndices,
 List<T> list)