How to Execute a Query on a Rule Project

Samples > Rule Studio Business Rule Management Extensions > How to Execute a Query on a Rule Project

How to Execute a Query on a Rule Project

This sample shows how to execute a query on your business rules using the query API. It takes as input a query and a target project which contains the rules. The input query can be supplied in one of the following ways:

as a path to a query in a rule project
as a simple text string
as a path to a query in a zip file

Key Features

Key features include:

Develop an Eclipse plug-in using the exposed Rule Studio API
Automate Rule Studio tasks through Ant tasks
Retrieve a project, query, and query folder in the workspace from a name
Check if a project or a query are defined in the workspace
Execute a query defined as a simple text or from an existing query in a rule project

Importing this Sample

This sample extends the Rule Studio API, and the required sample plug-ins are delivered as pre-deployed. If you have not already done so, you must install the samples extension site in Eclipse before running the sample.

To install the plug-in samples extension site:

Click Help > Software Updates > Manage Configuration
In the Product Configuration dialog, click the Add an Extension Location link.
In the Browse dialog, select the folder <InstallDir>/studio/samples/eclipse.
If prompted to restart the Eclipse Workbench, click Yes.

Eclipse shuts down and restarts.

To check that the Query Execution Sample feature is enabled:

In the Rule Explorer, select the loanvalidation-rules project.
Click Help > Software Updates > Manage Configuration.
In the left pane of the Product Configuration page, expand C:\ILOG\JRules\studio\samples\eclipse and check that Query Execution Sample 1.0.0. is listed.

To import the queryexecution sample:

Click File > Import.
In the Import Wizard, select ILOG Rule Studio Samples and Tutorials then click Next.
Select the sample brmanagement > queryexecution.
Click Finish.
If one or more files already exist in your workspace, a warning message is displayed indicating the file(s) were not re-imported. Close the message window.

The imported sample project files are displayed in the Rule Explorer. You should see the following new projects:

- loanvalidation-rules. The target sample rule project. This project contains rules on which the query will be executed.

- loanvalidation-xom. A Java project containing the execution model of loanvalidation_rules.

- queryexecution-application. A Java project including an Ant build file (build.xml) which contains different Ant tasks that will be used in order to demonstrate different execution scenarios. Notice that the project includes a zip file containing a query, which will be used in one of the sample scenarios

- queryexecution-queries-container. A rule project containing a query that will be executed.

Note

The target init.runtime was added in the build.xml file to help Eclipse set the runtime properties: os (operating system), ws (window system) and arch (architecture) before executing the query. This should work for most common configurations. If it does not match your runtime environment, you can modify the Ant target to force the values of these properties.

Running the Sample

You need to be in the Rule Perspective to run this sample.

To switch to the Rule perspective:

Click Window > Open Perspective > Other.
Select the Rule perspective then click OK.

To run the sample:

Click Run > External Tools > External Tools.
In the External Tools dialog, in the Configurations list, click Ant Build > queryexecution-application.
Click Run.
Output is displayed in the Console view:

executionWithZipFile:

   [echo] executing query on loanvalidation-rules project with arguments:
     zip:querycontainer.zip/queries-container/queries/completeness/
     documentation scope: true

   [java] Arguments : project='loanvalidation-rules' query='querycontainer.zip/
     queries-container/queries/completeness/documentation' mode='zip' scope='true'

   [java] <?xml version="1.0" encoding="UTF-8"?>

   [java] <queryexecution>

...

   [java] </queryexecution>

   [java] Query (mode=zip) successfully executed [1 element(s) processed].

executionWithQueryPath:

   [echo] executing query on loanvalidation-rules project with arguments:
     path:queryexecution-queries-container/queries/completeness/documentation scope: true

   [java] Arguments : project='loanvalidation-rules' query='queryexecution
     -queries-container/queries/completeness/documentation' mode='path' scope='true'

   [java] <?xml version="1.0" encoding="UTF-8"?>

   [java] <queryexecution>

...

   [java] </queryexecution>

   [java] Query (mode=path) successfully executed [1 element(s) processed].

executionWithQueryString:

   [echo] executing query on loanvalidation-rules project with arguments:
     text:Find all business rules such that the documentation of each business
     rule is empty scope: true

   [java] Arguments : project='loanvalidation-rules' query='Find all
     business rules such that the documentation of each business rule is empty'
     mode='text' scope='true'

   [java] <?xml version="1.0" encoding="UTF-8"?>

   [java] <queryexecution>

...

   [java] </queryexecution>

   [java] Query (mode=text) successfully executed [1 element(s) processed].

Source Files

To display the source code of the queryexecution Eclipse plug-in:

Click File > Import.
In the Import Wizard, select External Plug-ins and Fragments and click Next.
In the Import As section, select the Projects with source folders option and click Next.
In the Plug-ins and Fragments Found list, scroll down and select the ilog.rules.studio.samples.queryexecution plug-in (be careful not to select ilog.rules.studio.samples.queryexecution.source), then click Add.
Click Finish.

The plug-in source code is imported and appears in the Rule Explorer.

Switch to the Plug-in Development perspective.

Click Window > Open Perspective > Other. Select the plug-in Development perspective and then click OK.

In the Package Explorer, navigate to the Java source files in the ilog.rules.studio.samples.queryexecution > src-queryexecution folder.

The following source files are of interest and are described below in the Highlights section of this sample:

ilog.rules.studio.samples.queryexecution.helper.Model.java

ilog.rules.studio.samples.queryexecution.helper.ProjectElementprocessorDefaultImpl.java

Highlights

The query is executed using the class ilog.rules.studio.samples.queryexecution.Query. This class is defined in the eclipse plug-in description file as an extension for org.eclipse.core.runtime.applications and implements org.eclipse.core.runtime.IPlatformRunnable.

It is executed from within the build.xml file as an Eclipse headless application by using:

ilog.rules.studio.samples.queryexecution.headless.application

Notice that the real query execution is delegated to the ilog.rules.studio.samples.queryexecution.helper.Model class.

This application expects the following mandatory parameters (see the supplied build.xml file for a full list of parameters):