org.sonar.api.rules
Class RulesManager

java.lang.Object
  org.sonar.api.rules.RulesManager

All Implemented Interfaces:

BatchComponent, BatchExtension, Extension

public class RulesManager
extends java.lang.Object
implements BatchExtension

A class to manage and access rules defined in Sonar. UGLY CLASS - WILL BE COMPLETELY REFACTORED IN SONAR 2.2

Constructor Summary

protected	RulesManager(DaoFacade dao, Plugins plugins) Constructor for tests only
	RulesManager(Plugins plugins, RulesRepository[] repositories, DaoFacade dao) Creates a RuleManager

Method Summary

java.util.Map<java.lang.String,java.lang.Long>	countRulesByCategory(Language language) Gets count of rules by categories defined for a given language
protected java.util.Map<java.lang.String,java.lang.Long>	countRulesByCategory(Language language, RulesDao rulesDao)
java.util.List<Plugin>	getExportablePlugins(Language language) Get the list of rules plugin that implement a mechanism of export for a given language
java.util.List<Plugin>	getImportablePlugins(Language language) Get the list of rules plugin that implement a mechanism of import for a given language
java.util.Set<Language>	getLanguages() Returns the list of languages for which there is a rule repository
Rule	getPluginRule(java.lang.String pluginKey, java.lang.String ruleKey) Gets a rule belonging to a defined plugin based on its key
java.util.Collection<Rule>	getPluginRules(java.lang.String pluginKey) Gets a collection of rules belonging to a plugin
java.util.Map<java.lang.String,Rule>	getPluginRulesIndexedByKey(java.lang.String pluginKey) Gets a list of rules indexed by their key for a given plugin
java.util.List<Plugin>	getPlugins(Language language) Gets the list of rules plugins for a given language
java.util.List<RulesRepository<?>>	getRulesRepositories() Gets the complete list of Rules Repositories in the Sonar instance
java.util.List<RulesRepository<?>>	getRulesRepositories(Language language) Gets the list of Rules Repositories available for a language

Methods inherited from class java.lang.Object

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

Constructor Detail

RulesManager

public RulesManager(Plugins plugins,
                    RulesRepository[] repositories,
                    DaoFacade dao)

Creates a RuleManager

Parameters:

plugins - the plugins dictionnary

repositories - the repositories of rules

dao - the dao object

RulesManager

protected RulesManager(DaoFacade dao,
                       Plugins plugins)

Constructor for tests only

Parameters:

dao - the dao

Method Detail

getLanguages

public java.util.Set<Language> getLanguages()

Returns the list of languages for which there is a rule repository

Returns:

a Set of languages

getRulesRepositories

public java.util.List<RulesRepository<?>> getRulesRepositories(Language language)

Gets the list of Rules Repositories available for a language

Parameters:

language - the language

Returns:

the list of rules repositories

getRulesRepositories

public java.util.List<RulesRepository<?>> getRulesRepositories()

Gets the complete list of Rules Repositories in the Sonar instance

Returns:

the list of rules repositories

getPlugins

public java.util.List<Plugin> getPlugins(Language language)

Gets the list of rules plugins for a given language

Parameters:

language - the language

Returns:

the list of plugins

countRulesByCategory

public java.util.Map<java.lang.String,java.lang.Long> countRulesByCategory(Language language)

Gets count of rules by categories defined for a given language

Parameters:

language - the language

Returns:

a Map with the category as key and the count as value

countRulesByCategory

protected java.util.Map<java.lang.String,java.lang.Long> countRulesByCategory(Language language,
                                                                              RulesDao rulesDao)

getExportablePlugins

public java.util.List<Plugin> getExportablePlugins(Language language)

Get the list of rules plugin that implement a mechanism of export for a given language

Parameters:

language - the language

Returns:

the list of plugins

getImportablePlugins

public java.util.List<Plugin> getImportablePlugins(Language language)

Get the list of rules plugin that implement a mechanism of import for a given language

Parameters:

language - the language

Returns:

the list of plugins

getPluginRulesIndexedByKey

public java.util.Map<java.lang.String,Rule> getPluginRulesIndexedByKey(java.lang.String pluginKey)

Gets a list of rules indexed by their key for a given plugin

Parameters:

pluginKey - the plugin key

Returns:

a Map with the rule key and the rule

getPluginRules

public java.util.Collection<Rule> getPluginRules(java.lang.String pluginKey)

Gets a collection of rules belonging to a plugin

Parameters:

pluginKey - the plugin key

Returns:

the collection of rules

getPluginRule

public Rule getPluginRule(java.lang.String pluginKey,
                          java.lang.String ruleKey)

Gets a rule belonging to a defined plugin based on its key

Parameters:

pluginKey - the plugin key

ruleKey - the rule key

Returns:

the rule