com.imsweb.decisionengine

Class DecisionEngine

java.lang.Object

com.imsweb.decisionengine.DecisionEngine

public class DecisionEngine
extends java.lang.Object

An engine for processing declarative algorithms.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DecisionEngine(DataProvider provider) Construct the decision engine with the passed data provider

Method Summary

Modifier and Type	Method and Description
static java.lang.Integer	findMatchingTableRow(Table table, java.util.Map<java.lang.String,java.lang.String> context) Return the matching table row index based on the passed context
static java.lang.Integer	findMatchingTableRow(Table table, java.util.Map<java.lang.String,java.lang.String> context, java.util.Set<java.lang.String> keysToMatch) Return the matching table row index based on the passed context
java.util.Set<java.lang.String>	getInputs(Definition definition) Looks at all tables involved in all the mappings in the definition and returns a list of inputs that are used.
java.util.Set<java.lang.String>	getInputs(Mapping mapping, java.util.Set<java.lang.String> excludedInputs) Looks at all tables involved in the mapping and returns a list of inputs that are used.
java.util.Set<java.lang.String>	getInputs(TablePath path) Returns a list of inputs that are required for the specified TablePath.
java.util.Set<java.lang.String>	getInputs(TablePath path, java.util.Set<java.lang.String> excludedInputs) Returns a list of inputs that are required for the specified TablePath.
java.util.List<Mapping>	getInvolvedMappings(Definition definition, java.util.Map<java.lang.String,java.lang.String> context) Given a definition and context, return a list of mappings that match inclusion and exclusion criteria
java.util.Set<java.lang.String>	getInvolvedTables(Definition definition) Return a list of tables involved in an definition.
java.util.Set<java.lang.String>	getInvolvedTables(java.lang.String definitionId) Return a list of tables involved in a definition
java.util.Set<java.lang.String>	getOutputs(Definition definition) Looks at all tables involved in all the mappings in the definition and returns a list of outputs produced.
java.util.Set<java.lang.String>	getOutputs(Mapping mapping) Looks at all tables involved in the mapping and returns a list of outputs that are produced.
java.util.Set<java.lang.String>	getOutputs(TablePath path) Return a list of outputs that are produced form the specified TablePath.
DataProvider	getProvider() Returns the internal data provider
boolean	isMappingInvolved(Mapping mapping, java.util.Map<java.lang.String,java.lang.String> context) Given a mapping and a context, check the inclusion/exclusion tables to see if mapping should be processed
static boolean	isReferenceVariable(java.lang.String value) Checked whether the value is a reference to another variable or context
static java.util.List<? extends Endpoint>	matchTable(Table table, java.util.Map<java.lang.String,java.lang.String> context) Return the list of endpoints for the matching row in the table; returns null if there is no match
static java.util.List<? extends Endpoint>	matchTable(Table table, java.util.Map<java.lang.String,java.lang.String> context, java.util.Set<java.lang.String> keysToMatch) Return the list of endpoints for the matching row in the table; returns null if there is no match
Result	process(Definition definition, java.util.Map<java.lang.String,java.lang.String> context) Using the supplied context, process a definition.
Result	process(java.lang.String definitionId, java.util.Map<java.lang.String,java.lang.String> context) Using the supplied context, process an definition.
protected boolean	process(java.lang.String mappingId, java.lang.String tableId, TablePath path, Result result, java.util.Deque<java.lang.String> stack) Internal method to recursively process a table
void	setProvider(DataProvider provider) Sets the provider and initiaizes all definitions and tables
static boolean	testMatch(java.util.List<? extends Range> values, java.lang.String value, java.util.Map<java.lang.String,java.lang.String> context) Tests that a value is contained in a list of ranges; if the list of ranges is missing or empty, then all values will match to it
static java.lang.String	translateValue(java.lang.String value, java.util.Map<java.lang.String,java.lang.String> context) Translates a value.
static java.lang.String	trimBraces(java.lang.String value) Takes a key reference, like {{key}} and returns just the key ("key" in this example)

Methods inherited from class java.lang.Object

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

Field Detail

_BLANK_OUTPUT

public static final java.lang.String _BLANK_OUTPUT

See Also:

Constant Field Values

Constructor Detail

DecisionEngine

public DecisionEngine(DataProvider provider)

Construct the decision engine with the passed data provider

Parameters:

provider - a DataProvider

Method Detail

isReferenceVariable

public static boolean isReferenceVariable(java.lang.String value)

Checked whether the value is a reference to another variable or context

Parameters:

value - String value

Returns:

true if the value is a reference to another variable or context

trimBraces

public static java.lang.String trimBraces(java.lang.String value)

Takes a key reference, like {{key}} and returns just the key ("key" in this example)

Parameters:

value - a key refrerence

Returns:

the inner key

matchTable

public static java.util.List<? extends Endpoint> matchTable(Table table,
                                                            java.util.Map<java.lang.String,java.lang.String> context)

Return the list of endpoints for the matching row in the table; returns null if there is no match

Parameters:

table - a Table

context - a Map containing the context

Returns:

returns a List of Endpoint entities from the matching row or null if no match

matchTable

public static java.util.List<? extends Endpoint> matchTable(Table table,
                                                            java.util.Map<java.lang.String,java.lang.String> context,
                                                            java.util.Set<java.lang.String> keysToMatch)

Return the list of endpoints for the matching row in the table; returns null if there is no match

Parameters:

table - a Table

context - a Map containing the context

keysToMatch - if not null, only keys in this set will be matched against

Returns:

returns a List of Endpoint entities from the matching row or null if no match

findMatchingTableRow

public static java.lang.Integer findMatchingTableRow(Table table,
                                                     java.util.Map<java.lang.String,java.lang.String> context)

Return the matching table row index based on the passed context

Parameters:

table - a Table

context - a Map containing the context

Returns:

the index of the matching table row or null if no match was found

findMatchingTableRow

public static java.lang.Integer findMatchingTableRow(Table table,
                                                     java.util.Map<java.lang.String,java.lang.String> context,
                                                     java.util.Set<java.lang.String> keysToMatch)

Return the matching table row index based on the passed context

Parameters:

table - a Table

context - a Map containing the context

keysToMatch - if not null, only keys in this set will be matched against

Returns:

the index of the matching table row or null if no match was found

testMatch

public static boolean testMatch(java.util.List<? extends Range> values,
                                java.lang.String value,
                                java.util.Map<java.lang.String,java.lang.String> context)

Tests that a value is contained in a list of ranges; if the list of ranges is missing or empty, then all values will match to it

Parameters:

values - a List of Range objects

value - a value to look for

context - the context will be used to do key lookups when values are in the format of {{var}}

Returns:

return true if the value is contained in the List of Range objects

translateValue

public static java.lang.String translateValue(java.lang.String value,
                                              java.util.Map<java.lang.String,java.lang.String> context)

Translates a value. If it is a reference to a context, like {{var}} it will return the context value; otherwise if will return the value unchanged. If the context key does not exist in the context, blank will be returned

Parameters:

value - String value

context - Context for handling variable references

Returns:

the context value if a reference, otherwise the original value is returned

getProvider

public DataProvider getProvider()

Returns the internal data provider

Returns:

a DataProvider

setProvider

public void setProvider(DataProvider provider)

Sets the provider and initiaizes all definitions and tables

Parameters:

provider - a DataProvider

isMappingInvolved

public boolean isMappingInvolved(Mapping mapping,
                                 java.util.Map<java.lang.String,java.lang.String> context)

Given a mapping and a context, check the inclusion/exclusion tables to see if mapping should be processed

Parameters:

mapping - a Mapping

context - a Map containing the context

Returns:

true if the mapping is involved

getInvolvedMappings

public java.util.List<Mapping> getInvolvedMappings(Definition definition,
                                                   java.util.Map<java.lang.String,java.lang.String> context)

Given a definition and context, return a list of mappings that match inclusion and exclusion criteria

Parameters:

definition - a Definition

context - a Map containing the context

Returns:

a List of involved Mapping entities

getInvolvedTables

public java.util.Set<java.lang.String> getInvolvedTables(java.lang.String definitionId)

Return a list of tables involved in a definition

Parameters:

definitionId - an Definition identifier

Returns:

a set of table identifiers

getInvolvedTables

public java.util.Set<java.lang.String> getInvolvedTables(Definition definition)

Return a list of tables involved in an definition. This includes not only the tables paths, but also tables references in the input section.

Parameters:

definition - a Definition

Returns:

a set of table identifiers

getInputs

public java.util.Set<java.lang.String> getInputs(TablePath path)

Returns a list of inputs that are required for the specified TablePath. This method will deal with mapped inputs. Note that if an output key is added during the mapping and used as an input in one of the later tables, we do not want to include it in the final list of inputs. Order matters here since if the key was already used as an input before being re-mapped, then it is still considered an input, otherwise if should be excluded.

Parameters:

path - a TablePath

Returns:

a Set of unique inputs

getInputs

public java.util.Set<java.lang.String> getInputs(TablePath path,
                                                 java.util.Set<java.lang.String> excludedInputs)

Returns a list of inputs that are required for the specified TablePath. This method will deal with mapped inputs. Note that if an output key is added during the mapping and used as an input in one of the later tables, we do not want to include it in the final list of inputs. Order matters here since if the key was already used as an input before being re-mapped, then it is still considered an input, otherwise if should be excluded.

Parameters:

path - a TablePath

excludedInputs - a list of keys that should not be included in the inputs

Returns:

a Set of unique inputs

getInputs

public java.util.Set<java.lang.String> getInputs(Mapping mapping,
                                                 java.util.Set<java.lang.String> excludedInputs)

Looks at all tables involved in the mapping and returns a list of inputs that are used. This also includes the inputs used in the inclusion and exclusion tables if any.

Parameters:

mapping - a Mapping

excludedInputs - a list of keys that should not be included in the inputs

Returns:

a Set of unique inputs

getInputs

public java.util.Set<java.lang.String> getInputs(Definition definition)

Looks at all tables involved in all the mappings in the definition and returns a list of inputs that are used. It will also deal with mapped inputs.

Parameters:

definition - a Definition

Returns:

a Set of Strings contianing the unique Definition input keys

getOutputs

public java.util.Set<java.lang.String> getOutputs(TablePath path)

Return a list of outputs that are produced form the specified TablePath. It will also handle mapped outputs.

Parameters:

path - a TablePath

Returns:

a Set of Strings containing the unique Mapping output keys

getOutputs

public java.util.Set<java.lang.String> getOutputs(Mapping mapping)

Looks at all tables involved in the mapping and returns a list of outputs that are produced. It will also handle mapped outputs. Since inclusion/exclusion tables should not map any new values, they are not included in the calculation.

Parameters:

mapping - a Mapping

Returns:

a Set of Strings containing the unique Mapping output keys

getOutputs

public java.util.Set<java.lang.String> getOutputs(Definition definition)

Looks at all tables involved in all the mappings in the definition and returns a list of outputs produced. It will also handle mapped outputs.

Parameters:

definition - a Definition

Returns:

a Set of Strings containing the unique Mapping output keys

process

public Result process(java.lang.String definitionId,
                      java.util.Map<java.lang.String,java.lang.String> context)

Using the supplied context, process an definition. The results will be added to the context.

Parameters:

definitionId - an Definition identifier

context - a Map containing the context

Returns:

a Result

process

public Result process(Definition definition,
                      java.util.Map<java.lang.String,java.lang.String> context)

Using the supplied context, process a definition. The results will be added to the context.

Parameters:

definition - a Definition

context - a Map containing the context

Returns:

a Result

process

protected boolean process(java.lang.String mappingId,
                          java.lang.String tableId,
                          TablePath path,
                          Result result,
                          java.util.Deque<java.lang.String> stack)

Internal method to recursively process a table

Parameters:

mappingId - a Mapping identifier

tableId - a Table identifier

path - a TablePath

result - a Result

stack - a stack which tracks the path and makes sure the path doesn't enter an infinite recusive state

Returns:

a boolean indicating whether processing should continue