com.openrules.ruleengine

Class Decision

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.lang.Object>

com.openrules.ruleengine.Decision

All Implemented Interfaces:

com.openrules.types.IDecision, java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class Decision
extends java.util.HashMap<java.lang.String,java.lang.Object>
implements com.openrules.types.IDecision

Decision is the main class for creating and running decisions using the standard OpenRules decision templates defined in Excel.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GOALS_PREFIX

Constructor Summary

Constructors

Constructor and Description
Decision(OpenRulesEngine engine) A constructor for a decision called "decisionName" and created based on the already existing OpenRulesEngine "engine".
Decision(java.lang.String decisionName)
Decision(java.lang.String decisionName, OpenRulesEngine engine) A constructor for a decision called "decisionName" and created based on the already existing OpenRulesEngine "engine".
Decision(java.lang.String decisionName, java.lang.String xlsMainFileName) A constructor for a decision called "decisionName".
Decision(java.lang.String decisionName, java.lang.String xlsMainFileName, Decision parentDecision) Similar to Decision(String decisionName, String xlsMainFileName) but it also sets parentDecision for imported decisions to share reports

Method Summary

Modifier and Type	Method and Description
void	addBusinessMap(BusinessMap map)
void	addBusinessMap(java.lang.String packageName, java.lang.String businessConcept, java.util.HashMap hashMap)
void	addError(java.lang.String type, java.lang.String explanation)
void	addExpectation(java.lang.String variableName, java.lang.String value)
void	addTestObject(java.lang.String businessConcept, java.lang.Object object)
void	assign(java.lang.String name, com.openrules.types.Oper op, java.lang.String assignValue) Assigns "assignValue" to the variable "name" using an operator "op"
void	assign(java.lang.String name, com.openrules.types.Oper op, java.lang.String[] assignValues) Assigns "assignValues" to the array variable "name" using an operator "op"
void	assign(java.lang.String name, java.lang.String value) Assigns "assignValue" to the variable "name" using an operator "="
boolean	assignArrayFeature(java.lang.String variableName, java.lang.String oper, java.lang.String arrayName) Defines and array type (int[].
void	assignBigDecimalArrayFeature(java.lang.String variableName, java.lang.String oper, java.lang.String arrayName) Defines a feature of the array "arrayName" using the "oper" (Min, Max, Average, etc.) and assigns it to the variable "variableName"
void	assignDoubleArrayFeature(java.lang.String variableName, java.lang.String oper, java.lang.String arrayName) Defines a feature of the array "arrayName" using the "oper" (Min, Max, Average, etc.) and assigns it to the variable "variableName"
void	assignIntArrayFeature(java.lang.String variableName, java.lang.String oper, java.lang.String arrayName) Defines a feature of the array "arrayName" using the "oper" (Min, Max, Average, etc.) and assigns it to the variable "variableName"
void	assignLongArrayFeature(java.lang.String variableName, java.lang.String oper, java.lang.String arrayName) Defines a feature of the array "arrayName" using the "oper" (Min, Max, Average, etc.) and assigns it to the variable "variableName"
void	assignMap(java.lang.String mapName, java.lang.String key, java.lang.String value) Puts "value" with the "key"into the map"mapName"
void	assignValueToVariable(java.lang.String var, java.lang.String value) This method is called from Excel template columns that assign a value to a variable
void	buildExecutionPath(java.lang.String decisionName, java.lang.String decisionFile) Calls buildExecutionPath(decisionName,decisionFile, false);
void	buildExecutionPath(java.lang.String decisionName, java.lang.String decisionFile, boolean additionalDecisions) Builds an execution path and then create an Excel file 'decisionFile' with two tables: - Decision , where "decisionName" is created by calling getDecisionNameUsingGoal(decisionName) - Environment that includes a reference to the main Excel file of this decision
void	cleanErrors()
void	closeReport()
boolean	compare(java.lang.String name, com.openrules.types.Oper op, java.lang.String value) Compares "value" with the value of the decision "name" using operator "op"
boolean	compare(java.lang.String name, com.openrules.types.Oper op, java.lang.String[] compareValues) Checks if the value of the decision variable "name" is comparable with elements of "compareValues" as defined by the operator "op"
boolean	compare(java.lang.String name, java.lang.String value) Checks if the value of the decision variable "name" is among elements of "compareValues"
boolean	compareBool(java.lang.String name, java.lang.String op, boolean value) Compares a boolean "value" with the value of the variable "name" using "op"
boolean	compareBool(java.lang.String name1, java.lang.String op, java.lang.String name2) Compares values of two boolean decision variables using "op"
boolean	compareDate(java.lang.String name, java.lang.String op, java.util.Date date) Compares the value of the variable "name" with the "date"
boolean	compareDate(java.lang.String name1, java.lang.String op, java.lang.String name2) Compares values of two Date decision variables using "op"
boolean	compareDomain(java.lang.String name, java.lang.String op, java.lang.String domain)
boolean	compareInt(java.lang.String name, java.lang.String op, int value) Compares the decision variable's value with the "value" using the operator "op"
boolean	compareInt(java.lang.String name1, java.lang.String op, java.lang.String name2) Compares values of two integer decision variables
boolean	compareReal(java.lang.String name, java.lang.String op, double value) Compares the decision variable's value with the "value" using the operator "op"
boolean	compareReal(java.lang.String name1, java.lang.String op, java.lang.String name2) Compares values of two real decision variables
boolean	compareString(java.lang.String name, java.lang.String op, java.lang.String value) Compares "value" with the value of the decision "name" using "op"
java.util.List<BusinessMap>	createBusinessMaps(java.lang.String packageName)
void	createRunReport(java.lang.String path, java.lang.String decisionName, java.lang.String decisionRunName)
boolean	evaluateBigDecimalArray(java.lang.String arrayName, java.lang.String oper, java.lang.String condition) If oper is "All Elements", then it checks if all elements in the array "arrayName" satisfy the condition If oper is "One Element", then it checks if at least one element in the array "arrayName" satisfies the condition
boolean	evaluateDoubleArray(java.lang.String arrayName, java.lang.String oper, java.lang.String condition) If oper is "All Elements", then it checks if all elements in the array "arrayName" satisfy the condition If oper is "One Element", then it checks if at least one element in the array "arrayName" satisfies the condition
boolean	evaluateIntArray(java.lang.String arrayName, java.lang.String oper, java.lang.String condition) If oper is "All Elements", then it checks if all elements in the array "arrayName" satisfy the condition If oper is "One Element", then it checks if at least one element in the array "arrayName" satisfies the condition
boolean	evaluateLongArray(java.lang.String arrayName, java.lang.String oper, java.lang.String condition) If oper is "All Elements", then it checks if all elements in the array "arrayName" satisfy the condition If oper is "One Element", then it checks if at least one element in the array "arrayName" satisfies the condition
boolean	evaluateMap(java.lang.String mapName, java.lang.String key, java.lang.String value) Finds a map associated in the glossary with the name "mapName" and checks if it contains the same value as "value" for the key "key"
java.lang.Object	execute() This method executes this decision by running a related OpenRulesEngine for the Excel's method with the decision's name
java.lang.Object	execute(boolean objectTypesVary) This method executes this decision by running a related OpenRulesEngine for the Excel's method with the decision's name.
java.lang.Object	execute(java.lang.String methodName) This method executes this decision by running a related OpenRulesEngine for the Excel's method passed as a parameter.
java.lang.Object	execute(java.lang.String methodName, java.lang.Object param) This method executes this decision by running a related OpenRulesEngine for the Excel's method "methodName" with one parameter "param".
java.lang.Object	execute(java.lang.String methodName, java.lang.Object[] params) This method executes this decision by running a related OpenRulesEngine for the Excel's method "methodName" with parameters defined by the array "params".
java.lang.Object	executeAction(java.lang.String methodName) This method is called from Excel template columns of the type ActionExecute
boolean	executeOneTest(DecisionTest test)
boolean	executeOneTest(java.lang.String testId)
java.lang.Object	executeWithBusinessMaps()
void	generateDecisionObject(java.lang.String className, java.lang.String packageName, java.lang.String path)
void	generateDecisionObjects(java.lang.String packageName, java.lang.String path)
java.math.BigDecimal	getBigDecimal(java.lang.String name)
java.math.BigDecimal[]	getBigDecimalArray(java.lang.String variableName)
boolean	getBool(java.lang.String name)
java.lang.Object	getBusinessObject(java.lang.String businessConcept)
CollectionHandler	getCollectionHandler()
java.lang.Object[]	getData(java.lang.String dataName) Returns an array of objects defined in Excel Data table "name"
java.util.Date	getDate(java.lang.String name)
java.lang.String	getDecisionNameUsingGoal(java.lang.String goal)
java.lang.Object	getDecisionObject(java.lang.String name)
double[]	getDoubleArray(java.lang.String variableName)
org.apache.commons.beanutils.DynaClass	getDynaClass(java.lang.String className)
OpenRulesEngine	getEngine()
java.util.List<com.openrules.types.Error>	getErrors()
DecisionExecutionPath	getExecutionPath() This method returns the existing or builds a new execution path for this decision
DecisionExecutionPath	getExecutionPath(java.lang.String goal) This method returns the existing or builds a new execution path for the "goal" (a decision variable)
DecisionExecutionPath	getExecutionPathBuilder()
DecisionExecutionPath	getExecutionPathBuilder(java.lang.String goal)
Glossary	getGlossary()
java.lang.String[]	getGoals()
java.lang.String[]	getGoals(boolean forImportedDecision)
Decision	getImportedDecisionFor(java.lang.String variable) Finds an imported sub-decision that defines the "variable".
java.util.ArrayList<Decision>	getImportedDecisions()
int	getInt(java.lang.String name)
int[]	getIntArray(java.lang.String variableName)
long	getLong(java.lang.String name)
long[]	getLongArray(java.lang.String variableName)
char	getLongNameIndicator()
DecisionMismatch[]	getMismatches()
java.lang.String	getName()
java.lang.Object	getObject(java.lang.String name)
java.lang.Object[]	getObjects(java.lang.String arrayName)
java.lang.Object	getOutput()
double	getReal(java.lang.String name)
org.openl.util.IReport	getReport()
java.lang.String	getRuleId()
java.util.Vector<java.lang.String>	getRunLog()
java.lang.String	getRunName()
java.lang.String	getString(java.lang.String name)
java.lang.String[]	getStringArray(java.lang.String variableName)
java.util.ArrayList<DecisionTest>	getTests()
java.lang.Object	getVariable(java.lang.String variableName) Returns an object defined in Excel Variable table "name"
java.lang.Object	getVarValue(java.lang.String name)
boolean	hasMismatches()
boolean	hasNoErrors()
void	importDecision(Decision decision) Calls importDecision(decision.getName(), decision);
void	importDecision(java.lang.String extrenalName, Decision decision) Adds "decision" as an imported sub-decision of this decision and makes it available to xls-based decision tables under the name "externalName"
void	importDecision(java.lang.String decisionXlsFile, java.lang.String decisionName) Calls importDecision(decisionXlsFile, decisionName, decisionName);
Decision	importDecision(java.lang.String decisionXlsFile, java.lang.String internalDecisionName, java.lang.String externalDecisionName) Creates a new Decision using internalDecisionName and decisionXlsFile.
boolean	isDecisionVariable(java.lang.String name)
boolean	isFEELOn()
boolean	isFirstRun()
boolean	isReportOn()
boolean	isTraceOn()
boolean	isVarUnknown(java.lang.String varName) This method is used by Rule Solver - see Conclusion column in theDecisionTableSolveTemplate
void	iterate(java.lang.String collectionName, java.lang.String rules) Iterates over an array "arrayName" using Excel's decision table "rules"
void	iterate(java.lang.String arrayName, java.lang.String arrayType, java.lang.String rules) Iterates over an array "arrayName" with elements of the type "arrayType" using Excel's decision table "rules"
void	iterateWithBreak(java.lang.String collectionName, java.lang.String rules, java.lang.String breakVariable) Iterates over an array "arrayName" using Excel's decision table "rules".
void	iterateWithBreak(java.lang.String collectionName, java.lang.String elementType, java.lang.String rules, java.lang.String breakVariable) Iterates over an array "arrayName" using Excel's decision table "rules".
void	log(java.lang.Object object) The same as log(object.toString())
void	log(java.lang.String text) Logs the "text" using OpenRulesEngine's method log(text)
void	logMessage(java.lang.String message, java.lang.String fromTable)
java.lang.String	macro(java.lang.String message) Replaces $RULE_ID to the latest executed rule's id inside the message-parameter.
DecisionObject	newDecisionObject(java.lang.String packageName, java.lang.String businessConcept)
void	newTest(java.lang.String id)
void	prepare(boolean objectTypesVary) Executes engine.run("decisionObjects",this) and engine.run("initializeDecisionRun",this);
void	printSavedRunLog() Prints the run log using Log.info(..)
void	printSavedRunLog(java.lang.String filename) Prints the run log to the file "filename"
java.lang.Object	put(java.lang.String key, java.lang.Object object) This method overrides HahMap method put.
void	putInitialTestObjects()
void	putObject(java.lang.String name, java.lang.Object object) Puts "object" under "name" into this decision and all its imported sub-decisions
java.util.ArrayList<DecisionTest>	readTestCases(java.lang.String decisionTests)
void	saveRunLog(boolean truefalse) Sets the mode "saveRunLog" for all future decision runs
void	setBool(java.lang.String name, boolean value) Sets boolean value to the decision variable"name"
void	setCollectionHandler(CollectionHandler collectionHandler)
void	setDate(java.lang.String name, java.util.Date date) Sets date value to the decision variable"name"
void	setErrors(java.util.List<com.openrules.types.Error> errors)
DecisionExecutionPath	setExecutionPath(java.lang.String goal) The same as getExecutionPath(goal)
void	setFirstRun(boolean firstRun) Sets the very first run of this decision to be true or false
void	setInitializeVar(java.lang.String arrayName, boolean flag)
void	setInt(java.lang.String name, int value) Sets integer value to the decision variable"name"
void	setLong(java.lang.String name, long value) Sets long value to the decision variable"name"
void	setName(java.lang.String name) Sets the decision name that is the name of the main Excel table of the type "Decision"
void	setOutput(java.lang.Object output) Sets the decision output object
void	setReal(java.lang.String name, double value) Sets real value to the decision variable"name"
void	setReport(org.openl.util.IReport report)
void	setRuleId(java.lang.String ruleId) Sets the latest executed rule's id available as $RULE_ID inside xls-templates
void	setRunName(java.lang.String runName) Sets a name of the current decision run
void	setString(java.lang.String name, java.lang.String value) Sets string value to the decision variable"name"
void	setTests(java.util.ArrayList<DecisionTest> tests)
void	sort(ComparableDecisionVariable[] array)
void	sort(ComparableDecisionVariable[] array, java.lang.String compareMethodForSort)
void	sort(java.util.List<ComparableDecisionVariable> collection, java.lang.String compareMethodForSort)
void	sort(java.lang.String arrayName) Sorts an array "arrayName" specified in the decision Glossary.
void	sort(java.lang.String collectionName, java.lang.String compareMethodForSort)
boolean	test()
boolean	test(java.util.ArrayList<DecisionTest> decisionTests)
boolean	test(java.util.ArrayList<DecisionTest> decisionTests, int numberOfTestsToBeExecuted)
boolean	test(int numberOfTestsToBeExecuted)
boolean	test(java.lang.String decisionTests)
boolean	test(java.lang.String decisionTests, int numberOfTestsToBeExecuted)
java.lang.String	toString() Returns a string with the decision's name and its glossary's size
void	updateReportedRule()
void	useBusinessObject(java.lang.String businessConcept, java.lang.Object object) Adds or Replaces (if is already there) the business object "object" associated with the glossary under the name "businessConcept".

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

GOALS_PREFIX

public static java.lang.String GOALS_PREFIX

Constructor Detail

Decision

public Decision(java.lang.String decisionName)

Decision

public Decision(java.lang.String decisionName,
                OpenRulesEngine engine)

A constructor for a decision called "decisionName" and created based on the already existing OpenRulesEngine "engine". This is not an expensive operation

Parameters:

decisionName -

engine -

Decision

public Decision(OpenRulesEngine engine)

A constructor for a decision called "decisionName" and created based on the already existing OpenRulesEngine "engine". This is not an expensive operation

Parameters:

decisionName -

engine -

Decision

public Decision(java.lang.String decisionName,
                java.lang.String xlsMainFileName)

A constructor for a decision called "decisionName". It also creates an instance of the OpenRulesEngine based on the xls-file "xlsMainFileName". This is an expensive operation

Parameters:

decisionName -

xlsMainFileName -

Decision

public Decision(java.lang.String decisionName,
                java.lang.String xlsMainFileName,
                Decision parentDecision)

Similar to Decision(String decisionName, String xlsMainFileName) but it also sets parentDecision for imported decisions to share reports

Parameters:

decisionName -

xlsMainFileName -

parentDecision -

Method Detail

getName

public final java.lang.String getName()

Returns:

a name of the decision that coincides with the name of the main Excel table of the type Decision

getGlossary

public final Glossary getGlossary()

Returns:

a decision's glossary

getEngine

public final OpenRulesEngine getEngine()

Returns:

an instance of the OpenRulesEngine associated with this decision

importDecision

public void importDecision(java.lang.String extrenalName,
                           Decision decision)

Adds "decision" as an imported sub-decision of this decision and makes it available to xls-based decision tables under the name "externalName"

Parameters:

extrenalName -

decision -

importDecision

public void importDecision(java.lang.String decisionXlsFile,
                           java.lang.String decisionName)

Calls importDecision(decisionXlsFile, decisionName, decisionName);

Parameters:

decisionXlsFile -

decisionName -

importDecision

public void importDecision(Decision decision)

Calls importDecision(decision.getName(), decision);

Parameters:

decision -

importDecision

public Decision importDecision(java.lang.String decisionXlsFile,
                               java.lang.String internalDecisionName,
                               java.lang.String externalDecisionName)

Creates a new Decision using internalDecisionName and decisionXlsFile. Puts a variable "FEEL" into the new decision with the same value as this decision. Adds new decision to the list of imported sub-decisions under externalDecisionName that will be used when new decision is invoked from using actions "ActionExecute"

Parameters:

decisionXlsFile -

internalDecisionName -

externalDecisionName -

Returns:

imported decision

putObject

public void putObject(java.lang.String name,
                      java.lang.Object object)

Puts "object" under "name" into this decision and all its imported sub-decisions

Parameters:

name -

object -

getImportedDecisions

public java.util.ArrayList<Decision> getImportedDecisions()

getImportedDecisionFor

public Decision getImportedDecisionFor(java.lang.String variable)

Finds an imported sub-decision that defines the "variable".

Parameters:

the - name of a decision variable

Returns:

decision or null

execute

public java.lang.Object execute()

This method executes this decision by running a related OpenRulesEngine for the Excel's method with the decision's name

Returns:

an object as defined by the Excel method with the decision's name

prepare

public void prepare(boolean objectTypesVary)

Executes engine.run("decisionObjects",this) and engine.run("initializeDecisionRun",this);

Parameters:

objectTypesVary -

execute

public java.lang.Object execute(boolean objectTypesVary)

This method executes this decision by running a related OpenRulesEngine for the Excel's method with the decision's name. First will try to execute engine.run(name, this) assuming that the name of this decision provides a method "name" in the table of the type "Decision". If the execution fails, it will try to interpret the decision's name as a goal. It will try to build an execution path for the goal "name". If success, it will execute this execution path, otherwise a RuntimeException will be thrown. If no exceptions, it will call engine.run("finalizeDecision", this). If object types vary between different calls of "execute() this decision will reset all attribute types for all glossary elements

Parameters:

objectTypesVary - if true then all elements in the decision will be rest to update the types of related business objects

Returns:

an object as defined by the Excel method with the decision's name

execute

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

This method executes this decision by running a related OpenRulesEngine for the Excel's method passed as a parameter. It is usually used when a method name is not known ahead of time and defined in run-time as a String.

Returns:

an object as defined by the Excel method "methodName"

executeAction

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

This method is called from Excel template columns of the type ActionExecute

Returns:

an object as defined by the Excel method "methodName"

assignValueToVariable

public void assignValueToVariable(java.lang.String var,
                                  java.lang.String value)

This method is called from Excel template columns that assign a value to a variable

execute

public java.lang.Object execute(java.lang.String methodName,
                                java.lang.Object[] params)

This method executes this decision by running a related OpenRulesEngine for the Excel's method "methodName" with parameters defined by the array "params".

Parameters:

methodName -

params - an array of the decision parameters

Returns:

an object as defined by the Excel method "methodName"

execute

public java.lang.Object execute(java.lang.String methodName,
                                java.lang.Object param)

This method executes this decision by running a related OpenRulesEngine for the Excel's method "methodName" with one parameter "param".

Parameters:

methodName -

param - a parameter of the decision parameters

Returns:

an object as defined by the Excel method "methodName"

getExecutionPathBuilder

public DecisionExecutionPath getExecutionPathBuilder()

getExecutionPathBuilder

public DecisionExecutionPath getExecutionPathBuilder(java.lang.String goal)

getExecutionPath

public DecisionExecutionPath getExecutionPath()

This method returns the existing or builds a new execution path for this decision

Returns:

the execution path for this decision

getExecutionPath

public DecisionExecutionPath getExecutionPath(java.lang.String goal)

This method returns the existing or builds a new execution path for the "goal" (a decision variable)

Parameters:

goal - a string that contains the name of a target decision variable

Returns:

the execution path that leads this decision to the target goal

setExecutionPath

public DecisionExecutionPath setExecutionPath(java.lang.String goal)

The same as getExecutionPath(goal)

buildExecutionPath

public void buildExecutionPath(java.lang.String decisionName,
                               java.lang.String decisionFile,
                               boolean additionalDecisions)

Builds an execution path and then create an Excel file 'decisionFile' with two tables: - Decision , where "decisionName" is created by calling getDecisionNameUsingGoal(decisionName) - Environment that includes a reference to the main Excel file of this decision

Parameters:

decisionName -

decisionFile -

additionalDecisions -

buildExecutionPath

public void buildExecutionPath(java.lang.String decisionName,
                               java.lang.String decisionFile)

Calls buildExecutionPath(decisionName,decisionFile, false);

Parameters:

decisionName -

decisionFile -

getDecisionNameUsingGoal

public java.lang.String getDecisionNameUsingGoal(java.lang.String goal)

Parameters:

goal -

Returns:

a string composed by the concatenation of the word "Decision" and the "goal", from which spaces and hyphens being removed

getGoals

public java.lang.String[] getGoals()

Returns:

getGoals(false)

getGoals

public java.lang.String[] getGoals(boolean forImportedDecision)

Parameters:

forImportedDecision -

Returns:

a string array that contains all goal except those which belong to the imported sub-decisions when forImportedDecision is false

isFirstRun

public boolean isFirstRun()

Returns:

true if this is the very first run of this decision

setFirstRun

public void setFirstRun(boolean firstRun)

Sets the very first run of this decision to be true or false

Parameters:

firstRun -

getRunLog

public java.util.Vector<java.lang.String> getRunLog()

Returns:

a vector of strings hat represents the log of the decision runs when the saveRunLof(true) was called

printSavedRunLog

public void printSavedRunLog()

Prints the run log using Log.info(..)

printSavedRunLog

public void printSavedRunLog(java.lang.String filename)

Prints the run log to the file "filename"

Parameters:

filename - a string

saveRunLog

public void saveRunLog(boolean truefalse)

Sets the mode "saveRunLog" for all future decision runs

Parameters:

truefalse - a boolean

log

public void log(java.lang.String text)

Logs the "text" using OpenRulesEngine's method log(text)

Parameters:

text - a string

log

public void log(java.lang.Object object)

The same as log(object.toString())

toString

public java.lang.String toString()

Returns a string with the decision's name and its glossary's size

Overrides:

toString in class java.util.AbstractMap<java.lang.String,java.lang.Object>

setName

public void setName(java.lang.String name)

Sets the decision name that is the name of the main Excel table of the type "Decision"

Parameters:

name - a string (no spaces)

getRunName

public java.lang.String getRunName()

Returns:

a name of the current decision run

setRunName

public void setRunName(java.lang.String runName)

Sets a name of the current decision run

Parameters:

runName - a string

getOutput

public java.lang.Object getOutput()

Returns:

an object that was set by the decision using setOutput(output)

setOutput

public void setOutput(java.lang.Object output)

Sets the decision output object

Parameters:

output - an output object

getRuleId

public java.lang.String getRuleId()

Returns:

the latest executed rule's id available as $RULE_ID inside xls-templates

setRuleId

public void setRuleId(java.lang.String ruleId)

Sets the latest executed rule's id available as $RULE_ID inside xls-templates

Parameters:

ruleId -

getVarValue

public java.lang.Object getVarValue(java.lang.String name)

Parameters:

name - a name of the decision variable

Returns:

an object that is the current value of the decision variable concatenated with ""

isVarUnknown

public boolean isVarUnknown(java.lang.String varName)

This method is used by Rule Solver - see Conclusion column in theDecisionTableSolveTemplate

Parameters:

varName - a string

Returns:

true is variable "varName" is defined as unknown in the glossary

macro

public java.lang.String macro(java.lang.String message)

Replaces $RULE_ID to the latest executed rule's id inside the message-parameter. The latest rule's id is set i the column"#" of any decision table. The default id is "?".

Parameters:

message -

Returns:

the same or modified message

getStringArray

public java.lang.String[] getStringArray(java.lang.String variableName)

Parameters:

variableName -

Returns:

an array of strings defined in the glossary using variableName

getIntArray

public int[] getIntArray(java.lang.String variableName)

Parameters:

variableName -

Returns:

an array of integers defined in the glossary using variableName

getLongArray

public long[] getLongArray(java.lang.String variableName)

Parameters:

variableName -

Returns:

an array of integers defined in the glossary using variableName

getDoubleArray

public double[] getDoubleArray(java.lang.String variableName)

Parameters:

variableName -

Returns:

an array of doubles defined in the glossary using variableName

getBigDecimalArray

public java.math.BigDecimal[] getBigDecimalArray(java.lang.String variableName)

Parameters:

variableName -

Returns:

an array of BigDecimals defined in the glossary using variableName

getInt

public int getInt(java.lang.String name)

Parameters:

name -

Returns:

an integer value of the integer decision variable with the name "name"

getLong

public long getLong(java.lang.String name)

Parameters:

name -

Returns:

an long value of the long decision variable with the name "name"

getReal

public double getReal(java.lang.String name)

Parameters:

name -

Returns:

a value of the real decision variable with the name "name"

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String name)

Parameters:

name -

Returns:

a value of the BigDecimal decision variable with the name "name"

getString

public java.lang.String getString(java.lang.String name)

Parameters:

name -

Returns:

a string value of the text decision variable with the name "name"

getDate

public java.util.Date getDate(java.lang.String name)

Parameters:

name -

Returns:

a Date value of the Date decision variable with the name "name"

getBool

public boolean getBool(java.lang.String name)

Parameters:

name -

Returns:

a boolean value of the boolean decision variable with the name "name"

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

getBusinessObject

public final java.lang.Object getBusinessObject(java.lang.String businessConcept)

Parameters:

businessConcept -

Returns:

an object associated in the glossary with the the "businessConcept"

getObject

public java.lang.Object getObject(java.lang.String name)

Parameters:

name -

Returns:

an object associated in the glossary with the name "name"

getObjects

public java.lang.Object[] getObjects(java.lang.String arrayName)

Parameters:

arrayName -

Returns:

an array of objects associated in the glossary with the name "arrayName"

isDecisionVariable

public boolean isDecisionVariable(java.lang.String name)

getCollectionHandler

public CollectionHandler getCollectionHandler()

setCollectionHandler

public void setCollectionHandler(CollectionHandler collectionHandler)

evaluateIntArray

public boolean evaluateIntArray(java.lang.String arrayName,
                                java.lang.String oper,
                                java.lang.String condition)

If oper is "All Elements", then it checks if all elements in the array "arrayName" satisfy the condition If oper is "One Element", then it checks if at least one element in the array "arrayName" satisfies the condition

Parameters:

arrayName -

oper -

expression -

Returns:

evaluateLongArray

public boolean evaluateLongArray(java.lang.String arrayName,
                                 java.lang.String oper,
                                 java.lang.String condition)

If oper is "All Elements", then it checks if all elements in the array "arrayName" satisfy the condition If oper is "One Element", then it checks if at least one element in the array "arrayName" satisfies the condition

Parameters:

arrayName -

oper -

expression -

Returns:

evaluateBigDecimalArray

public boolean evaluateBigDecimalArray(java.lang.String arrayName,
                                       java.lang.String oper,
                                       java.lang.String condition)

If oper is "All Elements", then it checks if all elements in the array "arrayName" satisfy the condition If oper is "One Element", then it checks if at least one element in the array "arrayName" satisfies the condition

Parameters:

arrayName -

oper -

expression -

Returns:

evaluateDoubleArray

public boolean evaluateDoubleArray(java.lang.String arrayName,
                                   java.lang.String oper,
                                   java.lang.String condition)

If oper is "All Elements", then it checks if all elements in the array "arrayName" satisfy the condition If oper is "One Element", then it checks if at least one element in the array "arrayName" satisfies the condition

Parameters:

arrayName -

oper -

expression -

Returns:

assignIntArrayFeature

public void assignIntArrayFeature(java.lang.String variableName,
                                  java.lang.String oper,
                                  java.lang.String arrayName)

Defines a feature of the array "arrayName" using the "oper" (Min, Max, Average, etc.) and assigns it to the variable "variableName"

Parameters:

variableName -

oper -

arrayName -

assignLongArrayFeature

public void assignLongArrayFeature(java.lang.String variableName,
                                   java.lang.String oper,
                                   java.lang.String arrayName)

Defines a feature of the array "arrayName" using the "oper" (Min, Max, Average, etc.) and assigns it to the variable "variableName"

Parameters:

variableName -

oper -

arrayName -

assignDoubleArrayFeature

public void assignDoubleArrayFeature(java.lang.String variableName,
                                     java.lang.String oper,
                                     java.lang.String arrayName)

Defines a feature of the array "arrayName" using the "oper" (Min, Max, Average, etc.) and assigns it to the variable "variableName"

Parameters:

variableName -

oper -

arrayName -

assignBigDecimalArrayFeature

public void assignBigDecimalArrayFeature(java.lang.String variableName,
                                         java.lang.String oper,
                                         java.lang.String arrayName)

Defines a feature of the array "arrayName" using the "oper" (Min, Max, Average, etc.) and assigns it to the variable "variableName"

Parameters:

variableName -

oper -

arrayName -

assignArrayFeature

public boolean assignArrayFeature(java.lang.String variableName,
                                  java.lang.String oper,
                                  java.lang.String arrayName)

Defines and array type (int[]. double[] or BigDecimal[]) and assign its feature (Min, Max, Average, etc.) to the variable "variableName"

Parameters:

variableName -

oper -

arrayName -

Returns:

evaluateMap

public boolean evaluateMap(java.lang.String mapName,
                           java.lang.String key,
                           java.lang.String value)

Finds a map associated in the glossary with the name "mapName" and checks if it contains the same value as "value" for the key "key"

Parameters:

mapName -

key -

value -

Returns:

true if yes; false if not or if there are no "mapName" found or there is no value for the "key"

assignMap

public void assignMap(java.lang.String mapName,
                      java.lang.String key,
                      java.lang.String value)

Puts "value" with the "key"into the map"mapName"

Parameters:

mapName -

key -

value -

setInt

public void setInt(java.lang.String name,
                   int value)

Sets integer value to the decision variable"name"

Parameters:

name -

value -

setLong

public void setLong(java.lang.String name,
                    long value)

Sets long value to the decision variable"name"

Parameters:

name -

value -

setReal

public void setReal(java.lang.String name,
                    double value)

Sets real value to the decision variable"name"

Parameters:

name -

value -

setString

public void setString(java.lang.String name,
                      java.lang.String value)

Sets string value to the decision variable"name"

Parameters:

name -

value -

setDate

public void setDate(java.lang.String name,
                    java.util.Date date)

Sets date value to the decision variable"name"

Parameters:

name -

date -

setBool

public void setBool(java.lang.String name,
                    boolean value)

Sets boolean value to the decision variable"name"

Parameters:

name -

value -

getDecisionObject

public java.lang.Object getDecisionObject(java.lang.String name)

Parameters:

name -

Returns:

an object associated in the glossary under the name "name"

compareInt

public boolean compareInt(java.lang.String name,
                          java.lang.String op,
                          int value)

Compares the decision variable's value with the "value" using the operator "op"

Parameters:

name - of a decision variable

op - as operator

value - an integer

Returns:

true if success

compareInt

public boolean compareInt(java.lang.String name1,
                          java.lang.String op,
                          java.lang.String name2)

Compares values of two integer decision variables

Parameters:

name1 -

op -

name2 -

Returns:

true if success

compareReal

public boolean compareReal(java.lang.String name,
                           java.lang.String op,
                           double value)

Compares the decision variable's value with the "value" using the operator "op"

Parameters:

name - of a decision variable

op - as operator

value - a double

Returns:

true if success

compareReal

public boolean compareReal(java.lang.String name1,
                           java.lang.String op,
                           java.lang.String name2)

Compares values of two real decision variables

Parameters:

name1 -

op -

name2 -

Returns:

true if success

compareDomain

public boolean compareDomain(java.lang.String name,
                             java.lang.String op,
                             java.lang.String domain)

Parameters:

name -

op -

domain -

Returns:

true if the value of the variable "name" is within "domain"

compareBool

public boolean compareBool(java.lang.String name,
                           java.lang.String op,
                           boolean value)

Compares a boolean "value" with the value of the variable "name" using "op"

Parameters:

name -

op -

value -

Returns:

true if success

compareBool

public boolean compareBool(java.lang.String name1,
                           java.lang.String op,
                           java.lang.String name2)

Compares values of two boolean decision variables using "op"

Parameters:

name1 -

op -

name2 -

Returns:

true if success

compareDate

public boolean compareDate(java.lang.String name,
                           java.lang.String op,
                           java.util.Date date)

Compares the value of the variable "name" with the "date"

Parameters:

name -

op -

date -

Returns:

true if success

compareDate

public boolean compareDate(java.lang.String name1,
                           java.lang.String op,
                           java.lang.String name2)

Compares values of two Date decision variables using "op"

Parameters:

name1 -

op -

name2 -

Returns:

true if success

compareString

public boolean compareString(java.lang.String name,
                             java.lang.String op,
                             java.lang.String value)

Compares "value" with the value of the decision "name" using "op"

Parameters:

name -

op - an operator's name like "Is"

value -

Returns:

true if success

compare

public final boolean compare(java.lang.String name,
                             com.openrules.types.Oper op,
                             java.lang.String value)

Compares "value" with the value of the decision "name" using operator "op"

Parameters:

name -

op - an operator

value -

Returns:

true if success

compare

public final boolean compare(java.lang.String name,
                             com.openrules.types.Oper op,
                             java.lang.String[] compareValues)

Checks if the value of the decision variable "name" is comparable with elements of "compareValues" as defined by the operator "op"

Parameters:

name - of a decision variable

op -

compareValues - as array of strings

Returns:

true if success

compare

public final boolean compare(java.lang.String name,
                             java.lang.String value)

Checks if the value of the decision variable "name" is among elements of "compareValues"

Parameters:

name - of a decision variable

value - as array of strings

Returns:

true if success

assign

public final void assign(java.lang.String name,
                         com.openrules.types.Oper op,
                         java.lang.String assignValue)

Assigns "assignValue" to the variable "name" using an operator "op"

Parameters:

name -

op -

assignValue -

assign

public final void assign(java.lang.String name,
                         com.openrules.types.Oper op,
                         java.lang.String[] assignValues)

Assigns "assignValues" to the array variable "name" using an operator "op"

Parameters:

name -

op -

assignValues -

assign

public final void assign(java.lang.String name,
                         java.lang.String value)

Assigns "assignValue" to the variable "name" using an operator "="

Parameters:

name -

value -

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object object)

This method overrides HahMap method put. Additionally to putting the pair key-object into this decision, it puts the pair to all imported decisions as well

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

put in class java.util.HashMap<java.lang.String,java.lang.Object>

useBusinessObject

public final void useBusinessObject(java.lang.String businessConcept,
                                    java.lang.Object object)

Adds or Replaces (if is already there) the business object "object" associated with the glossary under the name "businessConcept". Additionally it calls useBusinessObject(businessConcept, object) for all imported decisions as well

Parameters:

businessConcept -

object -

isTraceOn

public boolean isTraceOn()

Returns:

true if the decision has a pair ("trace","On") inside its map

isReportOn

public boolean isReportOn()

Returns:

true if the decision has a pair ("report","On") inside its map

isFEELOn

public boolean isFEELOn()

Returns:

true if the decision has a pair ("FEEL","On") inside its map

getLongNameIndicator

public char getLongNameIndicator()

newTest

public void newTest(java.lang.String id)

addTestObject

public void addTestObject(java.lang.String businessConcept,
                          java.lang.Object object)

addExpectation

public void addExpectation(java.lang.String variableName,
                           java.lang.String value)

readTestCases

public java.util.ArrayList<DecisionTest> readTestCases(java.lang.String decisionTests)

getTests

public java.util.ArrayList<DecisionTest> getTests()

setTests

public void setTests(java.util.ArrayList<DecisionTest> tests)

executeOneTest

public boolean executeOneTest(java.lang.String testId)

executeOneTest

public boolean executeOneTest(DecisionTest test)

putInitialTestObjects

public void putInitialTestObjects()

test

public boolean test(java.lang.String decisionTests)

test

public boolean test(java.lang.String decisionTests,
                    int numberOfTestsToBeExecuted)

test

public boolean test()

test

public boolean test(int numberOfTestsToBeExecuted)

test

public boolean test(java.util.ArrayList<DecisionTest> decisionTests)

test

public boolean test(java.util.ArrayList<DecisionTest> decisionTests,
                    int numberOfTestsToBeExecuted)

hasMismatches

public boolean hasMismatches()

Returns:

true if the method "test" discovered mismatches inside test cases

getMismatches

public DecisionMismatch[] getMismatches()

Returns:

an array of possible DecisionMismatches discovered by the method "test". Returns null if there are mismatches.

getErrors

public java.util.List<com.openrules.types.Error> getErrors()

setErrors

public void setErrors(java.util.List<com.openrules.types.Error> errors)

cleanErrors

public void cleanErrors()

addError

public void addError(java.lang.String type,
                     java.lang.String explanation)

hasNoErrors

public boolean hasNoErrors()

getDynaClass

public org.apache.commons.beanutils.DynaClass getDynaClass(java.lang.String className)

generateDecisionObject

public void generateDecisionObject(java.lang.String className,
                                   java.lang.String packageName,
                                   java.lang.String path)

generateDecisionObjects

public void generateDecisionObjects(java.lang.String packageName,
                                    java.lang.String path)

addBusinessMap

public void addBusinessMap(BusinessMap map)

createBusinessMaps

public java.util.List<BusinessMap> createBusinessMaps(java.lang.String packageName)

newDecisionObject

public DecisionObject newDecisionObject(java.lang.String packageName,
                                        java.lang.String businessConcept)

addBusinessMap

public void addBusinessMap(java.lang.String packageName,
                           java.lang.String businessConcept,
                           java.util.HashMap hashMap)

executeWithBusinessMaps

public java.lang.Object executeWithBusinessMaps()

createRunReport

public void createRunReport(java.lang.String path,
                            java.lang.String decisionName,
                            java.lang.String decisionRunName)

getReport

public org.openl.util.IReport getReport()

Specified by:

getReport in interface com.openrules.types.IDecision

setReport

public void setReport(org.openl.util.IReport report)

Specified by:

setReport in interface com.openrules.types.IDecision

updateReportedRule

public void updateReportedRule()

Specified by:

updateReportedRule in interface com.openrules.types.IDecision

closeReport

public void closeReport()

iterateWithBreak

public void iterateWithBreak(java.lang.String collectionName,
                             java.lang.String rules,
                             java.lang.String breakVariable)

Iterates over an array "arrayName" using Excel's decision table "rules".

Parameters:

arrayName - string

rules - string

breakVariable - string: if not null the true value of this variable serves as a loop break

iterateWithBreak

public void iterateWithBreak(java.lang.String collectionName,
                             java.lang.String elementType,
                             java.lang.String rules,
                             java.lang.String breakVariable)

Iterates over an array "arrayName" using Excel's decision table "rules".

Parameters:

arrayName - string

rules - string

breakVariable - string: if not null the true value of this variable serves as a loop break

iterate

public void iterate(java.lang.String collectionName,
                    java.lang.String rules)

Iterates over an array "arrayName" using Excel's decision table "rules"

Parameters:

arrayName - string

rules - string

iterate

public void iterate(java.lang.String arrayName,
                    java.lang.String arrayType,
                    java.lang.String rules)

Iterates over an array "arrayName" with elements of the type "arrayType" using Excel's decision table "rules"

Parameters:

arrayName - string

arrayName - string

rules - string

setInitializeVar

public void setInitializeVar(java.lang.String arrayName,
                             boolean flag)

sort

public void sort(java.lang.String arrayName)

Sorts an array "arrayName" specified in the decision Glossary. Assumes that all elements of the array are defined in a subclass of ComparableDecisionVariable. To compare two elements of the array uses a decision table called "Compare"+arrayName. The name of all elements inside this array is defined by using element.getClass().getSimpleName(), e.g. "Passenger". The glossary must include two business concepts "Passenger1" and "Passenger2", which names are formed by adding "1" and "2" to the type of the array elements. These business concepts should at a minimum include all decision variables that are being used by the comparison decision table "ComparePassengers". See an example in the sample project "DecisionFlightRebooking".

Parameters:

arrayName -

sort

public void sort(java.lang.String collectionName,
                 java.lang.String compareMethodForSort)

sort

public void sort(ComparableDecisionVariable[] array)

sort

public void sort(ComparableDecisionVariable[] array,
                 java.lang.String compareMethodForSort)

sort

public void sort(java.util.List<ComparableDecisionVariable> collection,
                 java.lang.String compareMethodForSort)

logMessage

public void logMessage(java.lang.String message,
                       java.lang.String fromTable)