Learn Drools: Part II(Cross Product)

Learn Drools: Part  II(Cross Product)

In the previous article, we got a basic idea what is Drools and How it works. In this article, we pay attention to the details how Rule works with facts.


When we write Rules Often a question Pops up our mind is
How can I invoke one rule from another Rule like we call a method?

The answer is no we can’t call a Rule from another Rule , The reason Drools match the Rules with incoming data/facts and if data satisfies Rule condition it stores the data in an Agenda, It immediately not fire the then part of a Rule as, It may be possible Same Data or facts can be matched by different rules so It stores matching facts in a Agenda and after firing all rules then it takes the action on Agenda i.e fires the then parts on facts.


So, as the rules apply on data/facts it is not possible to call a rule from another as we can’t pass any arguments/facts  beforehand as facts are coming at runtime.



So, rather than confused the Rules with functional/oops programming consider it with RDBMS.

Where we can compare Drools Rules and Facts with RDBMS component


Drools Component
RDBMS Component
Data/Facts/Domain Object data structure
Table
Facts/Domain Objects
Rows
Fact /Domain Object attributes
Column
Domain Objects HAS-A relationship
Joining/Cartesian Product
Drools operators
Filter Criterias
Drools When
When in Sql
Drools Then
Trigger
Drools Rule
Sql Query

Try to understand the above relationship with a simple example, Suppose we have Two Domain Objects say Department and Employee, and Each Employee is associated with a Department.


Step 1: Creating Data structure for Department and Employee, Nothing but two Simple POJOs which same as Two tables Department and Employee.


Department.java

package com.example.droolsExample.pojo;

public class Department {
   
   String name;

   public String getName() {
      return name;
   }

   public void setName(String name) {
      this.name = name;
   }
   
   

}


Employee.java

package com.example.droolsExample.pojo;

public class Employee {
   
   String name;
   boolean manager;
   String message;
   Department dept;
   public String getName() {
      return name;
   }
   public void setName(String name) {
      this.name = name;
   }
   public boolean isManager() {
      return manager;
   }
   public void setManager(boolean manager) {
      this.manager = manager;
   }
   public String getMessage() {
      return message;
   }
   public void setMessage(String message) {
      this.message = message;
   }
   public Department getDept() {
      return dept;
   }
   public void setDept(Department dept) {
      this.dept = dept;
   }
   
   
   
   
   

}



Step 2: Create a simple rule

employee.drl

package com.rules

import com.example.droolsExample.pojo.Employee
import com.example.droolsExample.pojo.Department

rule "print cross product"
   when
      emp: Employee();
      dept: Department();
   then
   System.out.println("Fire print cross product Rule");
   System.out.println(dept.getName() + "::" + emp.getName()+ ": "+emp.getDept().getName());
end


We create a simple rule , it tells that for every instance of Employee and Department in working memory print the department name and employee name and Employee's department name.

It is same as the following sql

Select * from Employee emp Department dept where emp.deptId=dept.deptId

So it will create all cartesian product in Working memory

So If we have two departments and two employees in working memory it creates four combinations and then fires the rules on these combinations.


Step 3: Create Working memory and insert Objects to show the result.

package com.example.droolsExample;

import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;

import org.drools.compiler.compiler.DroolsParserException;
import org.drools.compiler.compiler.PackageBuilder;
import org.drools.core.RuleBase;
import org.drools.core.RuleBaseFactory;
import org.drools.core.WorkingMemory;

import com.example.droolsExample.pojo.Department;
import com.example.droolsExample.pojo.Employee;



public class DroolsTest {

   public static void main(String[] args) throws DroolsParserException,
          IOException {
      DroolsTest droolsTest = new DroolsTest();
      droolsTest.executeDroolsEmployee();
   }

       public void executeDroolsEmployee() throws DroolsParserException, IOException {

      PackageBuilder packageBuilder = new PackageBuilder();

      String ruleFile = "/com/rules/employee.drl";
      InputStream resourceAsStream = getClass().getResourceAsStream(ruleFile);

      Reader reader = new InputStreamReader(resourceAsStream);
      packageBuilder.addPackageFromDrl(reader);
      org.drools.core.rule.Package rulesPackage = packageBuilder.getPackage();
      RuleBase ruleBase = RuleBaseFactory.newRuleBase();
      ruleBase.addPackage(rulesPackage);

      WorkingMemory workingMemory = ruleBase.newStatefulSession();
     
      Department dep = new Department();
      dep.setName("Civil");
     
      Department dep1 = new Department();
      dep1.setName("IT");
     
      Employee emp = new Employee();
      emp.setName("Shamik Mitra");
      emp.setManager(true);
      emp.setDept(dep1);
     
      Employee emp1 = new Employee();
      emp1.setName("Samir Mitra");
      emp1.setManager(true);
      emp1.setDept(dep);
     
      workingMemory.insert(dep);
      workingMemory.insert(dep1);
      workingMemory.insert(emp);
      workingMemory.insert(emp1);
      workingMemory.fireAllRules();

   }

}


Step 4: Checking the Output
Civil::Shamik Mitra: IT
IT::Shamik Mitra: IT
Civil::Samir Mitra: Civil
IT::Samir Mitra: Civil

Please note that as we have inserted two employees Objects and Two department Objects in working memory so it creates four different combinations.

In the next Article, we will discuss  How to filter resultset using Drools?

Learn Drools: Part 1

Drools Introduction


When we implement a complex software often we require to maintains a set of rules which will be applied on a set of data to take action on them. In a regular term, we called them Rule Engine.
If there is a small set of rules we can create our own Rule Engine which will maintain a certain order and applied on incoming data to take the decision or categorize the data.
The advantage of maintaining own rule engine is that we have a pure control over the Rule Engine's algorithm so we can easily change the Algorithm logic , To be simple we don’t have to rely on the third party for the pattern matching logic.
On Other hand, if rules are ever changing or there is a huge set of rules probably we will not want to maintain our own Rule engine as it increases our development cost not only that how the Rule engine performs and it’s optimization, Who wants to take this responsibility?
It would be nice if we delegate that work to some third party which is tested and trusted. So we can clearly separate the data and logic.
Third Party maintains the Rule Engine application and we just define the Rules as a strategy, on top of it, it would be nice if it is declarative so Business Analyst can understand the logic.

Drools:
Drools is this kind of Business Logic integration Platform (BLiP). Drools is Open source project written in java, Red Hat and Jboss maintains Drools.


Drools has two main parts
1. Authoring : By Authoring we create Rules file for Drools this is (.drl ) the file which contains the Rule definition in a declarative way. In this file ,we can write a set of Rules which will be fired at the run time. It is Developer's responsibility to write these Rules as per business requirements.
2. Runtime : By Runtime we create working memory , It is same as Session in Hibernate. As Rules file contains a set of rules, Runtime creating memory load these rules and apply on the incoming data , In drools, we called incoming data as facts.

Rules :
A rule is nothing but the logic which will be applied on incoming data. It has two main parts when and then.
When : It determines the condition,on which condition the Rule will be fired.
Then : It is the action If rules met the condition, its defines what work this rule performs

Syntax :

rule <Rule Name>

  when

    <condition>

  then

    <Action>

End 



Problem : We will greet a Person based on current time.
We will define the rules in Drools files , Drool will load these rules and fire on the incoming data.
Step 1. Create a .drl (droolRule.drl)file where we will define the rules.

package com.rules

import com.example.droolsExample.Person

rule "Good Morning"
    when
    person: Person(time >= 0 , time < 12)
    then
    person.setGreet("Good Morning " + person.getName());
    end
rule "Good Afternoon"
    when
    person: Person(time >= 12 , time < 16)
    then
    person.setGreet("Good Afternoon " + person.getName());
    end
rule "Good Night"
    when
    person: Person(time >= 16 , time <= 24)
    then
    person.setGreet("Good Night " + person.getName());
    end



Please note that here we create three rules “Good Morning”, “Good Afternoon “ and “Good Night.” In when section we check the current time based on the Person POJO’s time property . and in then part, we set the greet message accordingly.


Step 2: Create Person POJO class

package com.example.droolsExample;

public class Person {

    private String name;
    private int time;
    private String greet;

    public String getGreet() {
    return greet;
    }
    public void setGreet(String greet) {
    this.greet = greet;
    }
    public String getName() {
    return name;
    }
    public void setName(String name) {
    this.name = name;
    }
    public int getTime() {
    return time;
    }
    public void setTime(int time) {
    this.time = time;
    }






Step 3: We create a class named DroolsTest.java, In this class, we take some steps.
Step a : Load the rule file i.e droolsTest.drl by using InputStream.
Step b: create a package using above rule and add them into drools PackageBuilder.
Step c: Create a RuleBase by using above Package. Rulebase is same as Sessionfactory in Hibernate it is costly.
Step d: Create a Working memory from this RuleBase. It is same as Session class in Hibernate. This Working memory manages the rules and incoming data. Apply the rules on the data.
Step e: Add incoming data into Working memory here we create a Person Object and add it into Working Memory
Step f: Fire all rules.

DroolsTest.java

package com.example.droolsExample;

import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;

import org.drools.compiler.compiler.DroolsParserException;
import org.drools.compiler.compiler.PackageBuilder;
import org.drools.core.RuleBase;
import org.drools.core.RuleBaseFactory;
import org.drools.core.WorkingMemory;



public class DroolsTest {

    public static void main(String[] args) throws DroolsParserException,
    IOException {
    DroolsTest droolsTest = new DroolsTest();
    droolsTest.executeDrools();
    }

    public void executeDrools() throws DroolsParserException, IOException {

    PackageBuilder packageBuilder = new PackageBuilder();

    String ruleFile = "/com/rules/droolsRule.drl";
    InputStream resourceAsStream = getClass().getResourceAsStream(ruleFile);

    Reader reader = new InputStreamReader(resourceAsStream);
    packageBuilder.addPackageFromDrl(reader);
    org.drools.core.rule.Package rulesPackage = packageBuilder.getPackage();
    RuleBase ruleBase = RuleBaseFactory.newRuleBase();
    ruleBase.addPackage(rulesPackage);

    WorkingMemory workingMemory = ruleBase.newStatefulSession();

    Person person = new Person();
    person.setName("Shamik Mitra");
    person.setTime(7);

    workingMemory.insert(person);
    workingMemory.fireAllRules();

    System.out.println(person.getGreet());
    }

}





Output:

Good Morning Shamik Mitra.

As we set the time 7, so it satisfies the Good Morning Rule condition and fire this rule.