Decision Tables for Jira - Documentation
Page tree

Versions Compared

Old Version 2

changes.mady.by.user Michal Boruta

Saved on

compared with

New Version Current

changes.mady.by.user Michal Boruta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

DecisionTableManager

Description
Manager for Decision Tables
Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api
Methods

DecisionTableOperations

getDecisionTableOperations

getDMNDecisionTableOperations(dmnModelName, decisionKey)

Description
Returns DecisionTableOperations instance for given DMN model name and decision key. Typically this method is used once and the returned operations instance can be stored in some service bean instance for later usage.
Multiple threads
DecisionTableOperations can
safely use DecisionTableOperations
be safely used by multiple threads.
Return
DecisionTableOperations instance
Parameters
  • String dmnModelName - DMN model name
  • String decisionKey - unique decision key within DMN model


DecisionTableOperations getDecisionTableOperations(definition)

Description
Returns DecisionTableOperations instance for given decision table definition. Typically this method is used once and the returned operations instance can be stored in some service bean instance for later usage. DecisionTableOperations can be safely used by multiple threads.
Return
DecisionTableOperations instance
Parameters
  • DecisionTableDefinition definition - decision table definition



DecisionTableOperations

Description
Decision table operations that provide execution of decision table queries.
Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api
Methods

DecisionTableResult executeQuery(inputParameters)

Description

Executes the decision table query build form given input parameters map and returns the result with matched entries. The input parameters map should contain keys for each required input

parameter

parameters.

Return
Result of the query
Parameters

Map<String, ?> inputParameters - the decision table input parameters used to build a decision table query

Throws

NoMatchedResultFound - In case there are no matching entries found for the specified query/input parameters. Throwing this may depend on the corresponding decision table definition

.



DecisionTableResult<T>

Description
Represents a result of decision table query execution. It could be a single value or a list of the values. That class allows getting
a result
results in various scenarios, which can help in additional result checking or conversions.
Type parameters

<T> - result object type 

Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api.query
Methods

T getResult()

Description

The decision table result with the default type, which is depended on the decision table definition.

Return
Default decision table result

Map<String, ?> first()

Description
Returns a found result or the first entry of the list result
Return
Single result element or null, if a list is empty or the value is null
Annotations
Nullable

Map<String, ?> firstNotEmpty()

Description
Returns a found result or the first entry of the list result
Return
Single result element
Throws
NoMatchedResultFound - in case if the result is null or it's an empty list
Annotations
Nonnull

Map<String, ?> single()

Description
Returns a found result or the first entry of the list result
Return
Single result element or null, if a list is empty or the value is null
Throws
TooManyMatchedResultFound - in case if the result is a list that contains more than one element
.
Annotations
Nullable

Map<String, ?> singleNonEmpty()

Description
Returns a found result or the first entry of the list result
Return
Single result element
Throws

NoMatchedResultFound - in case if the result is null or it's an empty list

TooManyMatchedResultFound - in case if the result is a list that contains more than one element

Annotations
Nonnull

List<Map<String, ?>> multi()

Description
Return a list of found entries
Return
  • The list of entries
,
  • if they exist
  • null if the result is null or it is an empty list
Annotations
Nullable

List<Map<String, ?>> multiNonNull()

Description
Return a list of found entries
Return
  • The list of entries
,
  • if they exist
  • An empty list if the result is null or it is an empty list
Annotations
Nonnull

List<Map<String, ?>> multiNonEmpty()

Description
Return a list of found entries
Return

The list of entries

,

if they exist

Throws
NoMatchedResultFound - in case if the result is null or it's an empty list
Annotations
Nonnull

DecisionTableQueryExecutionContextInfo getExecutionContextInfo()

Description
Returns the application message
,
which contains contextual information about the execution of a decision table query
Return
Contextual information about the execution of a decision table query



DecisionTableDefinition

Description
Represents the definition of the decision table.
Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api.model
Methods

String getName()

Description

A handler to decision table name - the name of the file.

Return
Decision table name

List<DecisionTableResultParameter> getParameters()

Description
A handler to input parameters list.
Return
Decision table input parameters

List<DecisionTableResultParameter> getResultParameters()

Description
A handler to output parameter list.
Return
Decision table input parameters

HitPolicy getHitPolicy()

Description
A handler to used hit policy.
Return
Decision Table hit policy


Info
To use DecisionTableDefinition we suggest to use DecisionTableDefinitionBuilder


DecisionTableParameters

Description
Represents the input parameter of the decision table.
Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api.model
Methods

String getName()

Description

A handler to the input parameter name - decision table column name, which should be equal to parameter name in json file.

Return
Parameter name

ParameterValueType getValueType()

Description
A handler to parameter value type.
Return
Parameter value type

ParameterOperator getOperator()

Description
A handler to parameter operator.
Return
Decision table input parameters


Info
To use DecisionTableParameter we suggest to use DecisionTableParameterBuilder


DecisionTableResultParameters

Description
Represents the output parameter of the decision table.
Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api.model
Methods

String getName()

Description

A handler to the output parameter name - decision table column name, which should be equal to parameter name in json file.

Return
Parameter name

ParameterValueType getValueType()

Description
A handler to parameter value type.
Return
Parameter value type


Info
To use DecisionTableResultParameter we suggest to use DecisionTableResultParameterBuilder


HitPolicy

Description
Policy that determines which results will be returned.
Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api.model
Options

FIRST - first matching result

COLLECT - all suitable results

ParameterOperator

Description
A method of values comparation for parameter.
Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api.model
Options

EQUALS - A = B

GREATER_THAN -  A>B

GREATER_THAN_OR_EQUALS - A>=B

LESS_THAN -  A<B

LESS_THAN_OR_EQUALS - A>=B

IN -  AϵB


ParameterValueType

Description
Value types for parameters.
Package
eu.rivetgroup.atlas.jira.plugins.decisiontables.api.model
Options

LONG -number value for integers

BIGDECIMAL -number value for floats

STRING -text value

STRING_SET  -text value collection