com.openrules.ruleengine

Class OpenRulesEngine

java.lang.Object

com.openrules.ruleengine.OpenRulesEngine

public class OpenRulesEngine
extends java.lang.Object

OpenRulesEngine is a convenience class to run different configurations of OpenRules-based rule engines. Its main constructor is:

public OpenRulesEngine(String xlsMainFileName)

The first parameter xlsMainFileName defines a data source that points to the main xls file with business rulesInMemory associated with this engine. This parameter can be presented using special prefixes in a way similar to the following samples:

• classpath:/some/package/MyMain.xls
• file:/some/folder/MyMain.xls
• http://localhost:8080/MyWebApp/MyMain.xls

You may use other variants of the OpenRulesEngine constructor to define the main method inside xlsMainFileName to be executed during OpenRulesEngine's run. You may also specify the method later on using setMethod() or directly in

run(methodName,businessObjects)

Before any run, OpenRulesEngine checks if the main xls file has been changed, and if "yes", it re-initializes the engine. You can shut down this check using

setCheckRuleUpdates(false)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPENRULES_MODE
static java.lang.String	OPENRULES_MODE_EXECUTE
static java.lang.String	OPENRULES_MODE_SOLVE
static java.lang.String	OPENRULES_MODE_VALIDATE

Constructor Summary

Constructors

Constructor and Description
OpenRulesEngine(java.util.Properties dbProperties, java.lang.String xlsMainFileName)
OpenRulesEngine(java.lang.String xlsMainFileName) This is the main constructor.
OpenRulesEngine(java.lang.String xlsMainFileName, java.lang.Class clazz) The first parameter xlsMainFileName defines a data source that points to the main xls file with business rulesInMemory associated with this engine.
OpenRulesEngine(java.lang.String xlsMainFileName, java.lang.Class clazz, ExternalRules externalRules)
OpenRulesEngine(java.lang.String xlsMainFileName, ExternalRules externalRules)
OpenRulesEngine(java.lang.String xlsMainFileName, java.lang.String methodName)
OpenRulesEngine(java.lang.String xlsMainFileName, java.lang.String methodName, java.lang.Class clazz)
OpenRulesEngine(java.lang.String xlsMainFileName, java.lang.String methodName, java.lang.Class clazz, ExternalRules externalRules, java.util.Properties dbProperties) A constructor for ExternalRules from a database

Method Summary

Modifier and Type	Method and Description
RuleMethod	checkAndSetRuleMethod(java.lang.String methodName)
boolean	doesMethodExist(java.lang.String methodName)
java.lang.Object	getAttachment()
java.lang.Object[]	getBusinessObjects()
java.lang.Object[]	getData(java.lang.String dataName) Returns an array of objects defined in Excel Data table "name"
com.openrules.datasource.IDataSource	getDataSource(java.lang.String path, org.openl.conf.IUserContext ucxt)
static java.util.Properties	getDbProperties()
ExternalRules	getExternalRules()
java.util.Iterator	getMethodIterator()
java.lang.String	getMethodName()
java.lang.String	getNotFoundMethod()
static java.lang.String	getRelease() Return the current OpenRules Release #
java.net.URL	getSourceURL(java.lang.String path, org.openl.conf.IUserContext ucxt) Deprecated - use getDataSource
java.lang.Object	getVariable(java.lang.String variableName) Returns an object defined in Excel Variable table "name"
java.lang.String	getVersion()
java.lang.String	getXlsMainFileName()
boolean	isCheckRuleUpdates()
boolean	isNonDefinedMethodsAllowed()
boolean	isNotDefinedWarning()
void	log(java.lang.String text) Logs a text using Log.info(text)
java.lang.Object	run() Run the engine with already defined methods and business objects
java.lang.Object	run(Decision decision) This method is equivalent to run(decision.getName(), decision);
java.lang.Object	run(java.lang.Object[] objects) Run the engine with already define method applied to the array of business objects provided as a parameter
java.lang.Object	run(java.lang.String methodName) Run the engine with the method "methodName" without parameters.
java.lang.Object	run(java.lang.String methodName, boolean mayNotDefined) Run the engine with the method "methodName" that does not have parameters.
java.lang.Object	run(java.lang.String methodName, java.lang.Object object) Run the engine with the method "methodName" applied to only one business object provided as a parameter "object".
java.lang.Object	run(java.lang.String methodName, java.lang.Object[] objects) Run the engine with the method "methodName" applied to the array of business objects provided as a parameter "objects".
java.lang.Object	run(java.lang.String methodName, java.lang.Object[] objects, boolean mayNotDefined)
java.lang.Object	run(java.lang.String methodName, java.lang.Object object, boolean mayNotDefined)
void	setAttachment(java.lang.Object attachment)
void	setBusinessObjects(java.lang.Object[] businessObjects)
void	setCheckRuleUpdates(boolean checkRuleUpdates)
static void	setCurrentUserPassword(java.lang.String password) Sets the POI BIFF8 encryption/decryption password for the current thread.
void	setExternalRules(ExternalRules externalRules)
void	setMethod(java.lang.String methodName) Defines a method inside xlsMainFile to run
void	setMethodName(java.lang.String methodName)
void	setNonDefinedMethodsAllowed(boolean nonDefinedMethodsAllowed)
void	setNotDefinedWarning(boolean notDefinedWarning) Allows or disallows "not defined" warnings
void	setNotFoundMethod(java.lang.String notFoundMethod)
void	setXlsMainFileName(java.lang.String fileName)
void	turnOffNotDefinedWarning() Suppresses "not defined" warnings

Methods inherited from class java.lang.Object

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

Field Detail

OPENRULES_MODE

public static java.lang.String OPENRULES_MODE

OPENRULES_MODE_EXECUTE

public static java.lang.String OPENRULES_MODE_EXECUTE

OPENRULES_MODE_VALIDATE

public static java.lang.String OPENRULES_MODE_VALIDATE

OPENRULES_MODE_SOLVE

public static java.lang.String OPENRULES_MODE_SOLVE

Constructor Detail

OpenRulesEngine

public OpenRulesEngine(java.lang.String xlsMainFileName,
                       java.lang.String methodName,
                       java.lang.Class clazz,
                       ExternalRules externalRules,
                       java.util.Properties dbProperties)

A constructor for ExternalRules from a database

Parameters:

xlsMainFileName -

methodName -

clazz -

externalRules -

dbProperties -

OpenRulesEngine

public OpenRulesEngine(java.util.Properties dbProperties,
                       java.lang.String xlsMainFileName)

OpenRulesEngine

public OpenRulesEngine(java.lang.String xlsMainFileName)

This is the main constructor. The parameter xlsMainFileName defines a data source that points to the main xls file with business rulesInMemory associated with this engine.

OpenRulesEngine

public OpenRulesEngine(java.lang.String xlsMainFileName,
                       ExternalRules externalRules)

OpenRulesEngine

public OpenRulesEngine(java.lang.String xlsMainFileName,
                       java.lang.String methodName)

OpenRulesEngine

public OpenRulesEngine(java.lang.String xlsMainFileName,
                       java.lang.Class clazz)

The first parameter xlsMainFileName defines a data source that points to the main xls file with business rulesInMemory associated with this engine. The second parameter is usually "null". In some cases, it can be set to this.getClass() for example when the engine is created inside a web session.

OpenRulesEngine

public OpenRulesEngine(java.lang.String xlsMainFileName,
                       java.lang.Class clazz,
                       ExternalRules externalRules)

OpenRulesEngine

public OpenRulesEngine(java.lang.String xlsMainFileName,
                       java.lang.String methodName,
                       java.lang.Class clazz)

Method Detail

getVersion

public java.lang.String getVersion()

setCurrentUserPassword

public static void setCurrentUserPassword(java.lang.String password)

Sets the POI BIFF8 encryption/decryption password for the current thread.

Parameters:

password - pass null to clear user password (and use default)

getRelease

public static java.lang.String getRelease()

Return the current OpenRules Release #

Returns:

String

log

public void log(java.lang.String text)

Logs a text using Log.info(text)

Parameters:

text -

setMethod

public void setMethod(java.lang.String methodName)

Defines a method inside xlsMainFile to run

Parameters:

methodName -

run

public java.lang.Object run()

Run the engine with already defined methods and business objects

run

public java.lang.Object run(java.lang.String methodName,
                            boolean mayNotDefined)

Run the engine with the method "methodName" that does not have parameters. If the parameter mayNotDefined if false then a runtime exception will be thrown when the "methodMame' is not defined. Otherwise, only a warning will be produced.

run

public java.lang.Object run(java.lang.String methodName)

Run the engine with the method "methodName" without parameters. If the method is not defined a runtime exception will be thrown.

run

public java.lang.Object run(java.lang.Object[] objects)

Run the engine with already define method applied to the array of business objects provided as a parameter

run

public java.lang.Object run(Decision decision)

This method is equivalent to run(decision.getName(), decision);

turnOffNotDefinedWarning

public void turnOffNotDefinedWarning()

Suppresses "not defined" warnings

isNotDefinedWarning

public final boolean isNotDefinedWarning()

Returns:

true if "not defined" warnings are allowed

setNotDefinedWarning

public final void setNotDefinedWarning(boolean notDefinedWarning)

Allows or disallows "not defined" warnings

Parameters:

notDefinedWarning -

isNonDefinedMethodsAllowed

public final boolean isNonDefinedMethodsAllowed()

setNonDefinedMethodsAllowed

public final void setNonDefinedMethodsAllowed(boolean nonDefinedMethodsAllowed)

run

public java.lang.Object run(java.lang.String methodName,
                            java.lang.Object[] objects,
                            boolean mayNotDefined)

run

public java.lang.Object run(java.lang.String methodName,
                            java.lang.Object[] objects)

Run the engine with the method "methodName" applied to the array of business objects provided as a parameter "objects".

Returns:

object that is the same object that the executed method will return.

doesMethodExist

public boolean doesMethodExist(java.lang.String methodName)

checkAndSetRuleMethod

public RuleMethod checkAndSetRuleMethod(java.lang.String methodName)

run

public java.lang.Object run(java.lang.String methodName,
                            java.lang.Object object)

Run the engine with the method "methodName" applied to only one business object provided as a parameter "object".

Returns:

object that is the same object that the executed method will return.

run

public java.lang.Object run(java.lang.String methodName,
                            java.lang.Object object,
                            boolean mayNotDefined)

getSourceURL

public java.net.URL getSourceURL(java.lang.String path,
                                 org.openl.conf.IUserContext ucxt)
                          throws java.net.MalformedURLException

Deprecated - use getDataSource

Throws:

java.net.MalformedURLException

getDbProperties

public static java.util.Properties getDbProperties()

getDataSource

public com.openrules.datasource.IDataSource getDataSource(java.lang.String path,
                                                          org.openl.conf.IUserContext ucxt)
                                                   throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

getXlsMainFileName

public java.lang.String getXlsMainFileName()

Returns:

Returns the xlsMainFileName.

setXlsMainFileName

public void setXlsMainFileName(java.lang.String fileName)

Parameters:

fileName - The fileName to set.

getMethodName

public java.lang.String getMethodName()

Returns:

Returns the methodName.

setMethodName

public void setMethodName(java.lang.String methodName)

Parameters:

methodName - The methodName to set.

getBusinessObjects

public java.lang.Object[] getBusinessObjects()

Returns:

Returns the businessObjects.

setBusinessObjects

public void setBusinessObjects(java.lang.Object[] businessObjects)

Parameters:

businessObjects - The businessObjects to set.

isCheckRuleUpdates

public boolean isCheckRuleUpdates()

Returns:

Returns the checkRuleUpdates.

setCheckRuleUpdates

public void setCheckRuleUpdates(boolean checkRuleUpdates)

Parameters:

checkRuleUpdates - The checkRuleUpdates to set.

getAttachment

public final java.lang.Object getAttachment()

setAttachment

public final void setAttachment(java.lang.Object attachment)

getExternalRules

public ExternalRules getExternalRules()

setExternalRules

public void setExternalRules(ExternalRules externalRules)

getMethodIterator

public java.util.Iterator getMethodIterator()

getNotFoundMethod

public java.lang.String getNotFoundMethod()

setNotFoundMethod

public void setNotFoundMethod(java.lang.String notFoundMethod)

getData

public java.lang.Object[] getData(java.lang.String dataName)

Returns an array of objects defined in Excel Data table "name"

Parameters:

name - a string with the name of the Excel Data table (e.g. "employees")

Returns:

an array of objects that should be cast to already known Java type such as Employee[]

getVariable

public java.lang.Object getVariable(java.lang.String variableName)

Returns an object defined in Excel Variable table "name"

Parameters:

name - a string with the name of the Excel Variable table (e.g. "employee")

Returns:

an object that should be cast to already known Java type such as Employee