com.github.kislayverma.rulette

Class RuleSystem

java.lang.Object

com.github.kislayverma.rulette.RuleSystem

All Implemented Interfaces:

Serializable

public class RuleSystem
extends Object
implements Serializable

This class models a rule-system comprising of rules and provides appropriate APIs to interact with it.

Author:

Kislay Verma

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuleSystem(String ruleSystemName, IDataProvider dataProvider) This constructor initializes a rule system of the given name by reading data from the credentials given in the data source URL.
RuleSystem(String ruleSystemName, IDataProvider dataProvider, RuleInputConfigurator inputConfig) This constructor initializes a rule system of the given name by reading data from the credentials given in the data source URL.

Method Summary

Modifier and Type	Method and Description
Rule	addRule(Map<String,String> inputMap) This method adds a new rule to the rule system.
Rule	addRule(Rule newRule) This method adds the given rule to the rule system with a new rule id.
void	addRuleInput(RuleInputMetaData ruleInput) This method adds a new rule input to this rule system.
static void	createNewRuleSystem(RuleSystemMetaData metaData, IDataProvider dataProvider) Utility method to create a new rule system via the given data provider
boolean	deleteRule(Rule rule) This method deletes the given rule from the rule system.
boolean	deleteRule(String ruleId) This method deletes an existing rule from the rule system.
void	deleteRuleInput(String ruleInputName) This method deletes the rule input of the given name from this rule system.
static void	deleteRuleSystem(String ruleSystemName, IDataProvider dataProvider) Utility method to delete a rule system backed by the given data provider
List<Rule>	getAllApplicableRules(Map<String,String> inputMap) This method returns a list of all the rules in the rule system.
List<String>	getAllColumnNames() Returns the names of all the columns in the rule system, including the unique input and output column names
List<Rule>	getAllRules() This method returns a list of all the rules in the rule system.
List<Rule>	getConflictingRules(Rule rule) This method returns a list of rules conflicting with the given rule.
List<String>	getInputColumnNames() Returns the names of all the columns in the rule system, excluding the unique input and output column names
RuleSystemMetaData	getMetaData() this method returns the metadata corresponding to this rule system.
String	getName() Returns the name of the rule system
Rule	getNextApplicableRule(Map<String,String> inputMap) This method returns the next rule that will be applicable to the inputs if the current rule applicable to the were to be deleted.
String	getOutputColumnName()
Rule	getRule(Map<String,String> inputMap) This method returns the rule applicable for the given combination of rule inputs.
Rule	getRule(Object request) This method returns the rule applicable for the given combination of rule inputs.
Rule	getRule(String ruleId) This method returns the applicable rule for the given input criteria.
String	getUniqueColumnName()
void	reload() This method reloads the whole rule system by pulling fresh configuration and data from the data provider
Rule	updateRule(Rule oldRule, Rule newRule) This method updates an existing rules with values of the new rule given.

Methods inherited from class java.lang.Object

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

Constructor Detail

RuleSystem

public RuleSystem(String ruleSystemName,
                  IDataProvider dataProvider)
           throws RuleConflictException

This constructor initializes a rule system of the given name by reading data from the credentials given in the data source URL. All rule input will be initiatized with default parameters and no custom data types will be supported.

Parameters:

ruleSystemName - Name of the rule system to be instantiated

dataProvider - An IDataProvider to load rules from

Throws:

RuleConflictException

RuleSystem

public RuleSystem(String ruleSystemName,
                  IDataProvider dataProvider,
                  RuleInputConfigurator inputConfig)
           throws RuleConflictException

This constructor initializes a rule system of the given name by reading data from the credentials given in the data source URL. Rule input will be initiatized with default parameters unless an override is provided via the inputConfig parameter. Custom data type will be supported only if appropriate configuration is provided.

Parameters:

ruleSystemName - Name of the rule system to be instantiated

dataProvider - An IDataProvider to load rules from

inputConfig - Configuration to support custom data types and behaviour for rule inputs

Throws:

RuleConflictException

Method Detail

createNewRuleSystem

public static void createNewRuleSystem(RuleSystemMetaData metaData,
                                       IDataProvider dataProvider)

Utility method to create a new rule system via the given data provider

Parameters:

metaData -

dataProvider -

deleteRuleSystem

public static void deleteRuleSystem(String ruleSystemName,
                                    IDataProvider dataProvider)

Utility method to delete a rule system backed by the given data provider

Parameters:

ruleSystemName -

getAllRules

public List<Rule> getAllRules()

This method returns a list of all the rules in the rule system.

Returns:

List of all rules configured in the rule system

getAllApplicableRules

public List<Rule> getAllApplicableRules(Map<String,String> inputMap)

This method returns a list of all the rules in the rule system.

Parameters:

inputMap - map of rule input values for which applicable rules are to be returned

Returns:

List of all rules applicable to the given input

getRule

public Rule getRule(Object request)
             throws IllegalAccessException

This method returns the rule applicable for the given combination of rule inputs.

Parameters:

request - A simple Object with @RuletteInput annotation on required fields values

Returns:

null if input is null, null if no rule is applicable for the given input combination the applicable rule otherwise.

Throws:

IllegalAccessException - if rule inputs cannot be accessed on the object

getRule

public Rule getRule(Map<String,String> inputMap)

This method returns the rule applicable for the given combination of rule inputs.

Parameters:

inputMap - Map with input names as keys and their String values as values

Returns:

null if input is null, null if no rule is applicable for the given input combination the applicable rule otherwise.

getRule

public Rule getRule(String ruleId)

This method returns the applicable rule for the given input criteria.

Parameters:

ruleId - Unique id of the rule to get looked up.

Returns:

A Rule object if a rule with the given id exists. null otherwise.

addRule

public Rule addRule(Map<String,String> inputMap)
             throws RuleConflictException

This method adds a new rule to the rule system. There is no need to provide the rule_id field in the input - it will be auto-populated.

Parameters:

inputMap - The rule input values for which a new rule is to be added

Returns:

the added rule if there are no overlapping rules null if there are overlapping rules null if the input constitutes an invalid rule as per the validation policy in use.

Throws:

RuleConflictException - if the rule to be added is a conflicting rule

addRule

public Rule addRule(Rule newRule)
             throws RuleConflictException

This method adds the given rule to the rule system with a new rule id.

Parameters:

newRule - The new rule to be added

Returns:

the added rule if there are no overlapping rules null if there are overlapping rules null if the input constitutes an invalid rule as per the validation policy in use.

Throws:

RuleConflictException - if the rule to be added is a conflicting rule

updateRule

public Rule updateRule(Rule oldRule,
                       Rule newRule)
                throws RuleConflictException

This method updates an existing rules with values of the new rule given. All fields are updated of the old rule are updated. The new rule is checked for conflicts before update.

Parameters:

oldRule - An existing rule

newRule - The rule containing the new field values to which the old rule will be updated.

Returns:

the updated rule if update creates no conflict. null if the input constitutes an invalid rule as per the validation policy in use.

Throws:

RuleConflictException - if the updated rule is a conflicting rule

deleteRule

public boolean deleteRule(String ruleId)

This method deletes an existing rule from the rule system.

Parameters:

ruleId - Unique id of the rule to be deleted

Returns:

true if the rule with given rule id was successfully deleted false if the given rule does not exist false if the given rule could not be deleted (for whatever reason).

deleteRule

public boolean deleteRule(Rule rule)

This method deletes the given rule from the rule system.

Parameters:

rule - The Rule to be deleted.

Returns:

true if the given rule was successfully deleted false if the given rule does not exist false if the given rule could not be deleted (for whatever reason).

getConflictingRules

public List<Rule> getConflictingRules(Rule rule)

This method returns a list of rules conflicting with the given rule.

Parameters:

rule - Rule object

Returns:

List of conflicting rules if any, empty list otherwise.

getNextApplicableRule

public Rule getNextApplicableRule(Map<String,String> inputMap)

This method returns the next rule that will be applicable to the inputs if the current rule applicable to the were to be deleted.

Parameters:

inputMap - Map with column Names as keys and column values as values.

Returns:

A Rule object if a rule is applicable after the currently applicable rule is deleted. null if no rule is applicable after the currently applicable rule is deleted. null id no rule is currently applicable.

getUniqueColumnName

public String getUniqueColumnName()

getOutputColumnName

public String getOutputColumnName()

getName

public String getName()

Returns the name of the rule system

Returns:

the name of the rule system

getAllColumnNames

public List<String> getAllColumnNames()

Returns the names of all the columns in the rule system, including the unique input and output column names

Returns:

names of all the columns in the rule system

getInputColumnNames

public List<String> getInputColumnNames()

Returns the names of all the columns in the rule system, excluding the unique input and output column names

Returns:

names of all columns for evaluation in the rule system

getMetaData

public RuleSystemMetaData getMetaData()

this method returns the metadata corresponding to this rule system. A copy of the actual data is returned to preserve immutability of the original data.

Returns:

RuleSystemMetaData for this rule system

addRuleInput

public void addRuleInput(RuleInputMetaData ruleInput)

This method adds a new rule input to this rule system. The current rule system metadata and rules are not impacted and the reload() API must be called explicitly by the user to bring the new rule input into effect.

Parameters:

ruleInput - The rule input definition to be added

deleteRuleInput

public void deleteRuleInput(String ruleInputName)

This method deletes the rule input of the given name from this rule system. The loaded rule system metadata and rules are not impacted and the reload() API must be called explicitly by the user to bring the new rule input into effect.

Parameters:

ruleInputName - The rule input definition to be deleted

reload

public void reload()
            throws RuleConflictException

This method reloads the whole rule system by pulling fresh configuration and data from the data provider

Throws:

RuleConflictException