de.viadee.bpm.vPAV.processing.dataflow

Class DataFlowRuleBuilder

java.lang.Object

de.viadee.bpm.vPAV.processing.dataflow.DataFlowRuleBuilder

All Implemented Interfaces:

ConditionedProcessVariableSet, ConstrainedProcessVariableSet, DataFlowRule, ProcessVariableSet

public class DataFlowRuleBuilder
extends Object
implements ProcessVariableSet, ConditionedProcessVariableSet, ConstrainedProcessVariableSet, DataFlowRule

Implements all stages of data flow rule construction. Unifying implementation in one class eases management of construction state. Only reason for it to be public is the static method "processVariables()" providing an elegant entry point to start definition of data flow rules.

Constructor Summary

Constructors

Constructor and Description
DataFlowRuleBuilder()

Method Summary

Modifier and Type	Method and Description
ProcessVariablePredicateBuilder<ConditionedProcessVariableSet>	andShouldBe() Begins a predicate construction to define an additional condition and combine it conjunctively after its creation with existing one.
ConditionedProcessVariableSet	andShouldBe(DescribedPredicateEvaluator<ProcessVariable> condition) Method to define a custom condition and combine it conjunctively after its creation with existing one.
ProcessVariablePredicateBuilder<ConstrainedProcessVariableSet>	andThatAre() Begins a predicate construction to define an additional constraint and combine it conjunctively after its creation with existing one.
ConstrainedProcessVariableSet	andThatAre(DescribedPredicateEvaluator<ProcessVariable> constraint) Method to define a custom constraint and combine it conjunctively after its creation with existing one.
DataFlowRule	because(String reason) Method to define a reason.
void	check(Collection<ProcessVariable> variables) Evaluates rule on the set of process variables.
Collection<EvaluationResult<ProcessVariable>>	evaluate(Collection<ProcessVariable> variables) Evaluates rule on the set of process variables.
CriticalityEnum	getCriticality()
String	getRuleDescription()
String	getViolationMessageFor(EvaluationResult<ProcessVariable> result)
ProcessVariablePredicateBuilder<ConditionedProcessVariableSet>	orShouldBe() Begins a predicate construction to define an additional condition and combine it disjunctively after its creation with existing one.
ConditionedProcessVariableSet	orShouldBe(DescribedPredicateEvaluator<ProcessVariable> condition) Method to define a custom condition and combine it disjunctively after its creation with existing one.
ProcessVariablePredicateBuilder<ConstrainedProcessVariableSet>	orThatAre() Begins a predicate construction to define an additional constraint and combine it disjunctively after its creation with existing one.
ConstrainedProcessVariableSet	orThatAre(DescribedPredicateEvaluator<ProcessVariable> constraint) Method to define a custom constraint and combine it disjunctively after its creation with existing one.
static ProcessVariableSet	processVariables() Entry point to start definition of data flow rules.
ProcessVariablePredicateBuilder<ConditionedProcessVariableSet>	shouldBe() Begins a predicate construction to define a condition.
ConditionedProcessVariableSet	shouldBe(DescribedPredicateEvaluator<ProcessVariable> condition) Method to define a custom condition.
ProcessVariablePredicateBuilder<ConstrainedProcessVariableSet>	thatAre() Begins a predicate construction to define a constraint.
ConstrainedProcessVariableSet	thatAre(DescribedPredicateEvaluator<ProcessVariable> constraint) Method to define a custom constraint.
DataFlowRule	withCriticality(CriticalityEnum criticality) Method to define criticality.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFlowRuleBuilder

public DataFlowRuleBuilder()

Method Detail

processVariables

public static ProcessVariableSet processVariables()

Entry point to start definition of data flow rules.

Returns:

initial step builder of rule building

shouldBe

public ConditionedProcessVariableSet shouldBe(DescribedPredicateEvaluator<ProcessVariable> condition)

Description copied from interface: ProcessVariableSet

Method to define a custom condition.

Specified by:

shouldBe in interface ConstrainedProcessVariableSet

Specified by:

shouldBe in interface ProcessVariableSet

Parameters:

condition - - Condition that should be fulfilled

Returns:

next step builder

shouldBe

public ProcessVariablePredicateBuilder<ConditionedProcessVariableSet> shouldBe()

Description copied from interface: ProcessVariableSet

Begins a predicate construction to define a condition.

Specified by:

shouldBe in interface ConstrainedProcessVariableSet

Specified by:

shouldBe in interface ProcessVariableSet

Returns:

First builder of predicate construction and specifying next stage of rule building with generic parameter.

orShouldBe

public ConditionedProcessVariableSet orShouldBe(DescribedPredicateEvaluator<ProcessVariable> condition)

Description copied from interface: ConditionedProcessVariableSet

Method to define a custom condition and combine it disjunctively after its creation with existing one.

Specified by:

orShouldBe in interface ConditionedProcessVariableSet

Parameters:

condition - - Condition that is to be appended disjunctively

Returns:

Same step builder as this is not a stage transition.

andShouldBe

public ProcessVariablePredicateBuilder<ConditionedProcessVariableSet> andShouldBe()

Description copied from interface: ConditionedProcessVariableSet

Begins a predicate construction to define an additional condition and combine it conjunctively after its creation with existing one.

Specified by:

andShouldBe in interface ConditionedProcessVariableSet

Returns:

First builder of predicate construction and specifying next stage of rule building with generic parameter.

orShouldBe

public ProcessVariablePredicateBuilder<ConditionedProcessVariableSet> orShouldBe()

Description copied from interface: ConditionedProcessVariableSet

Begins a predicate construction to define an additional condition and combine it disjunctively after its creation with existing one.

Specified by:

orShouldBe in interface ConditionedProcessVariableSet

Returns:

First builder of predicate construction and specifying next stage of rule building with generic parameter.

andShouldBe

public ConditionedProcessVariableSet andShouldBe(DescribedPredicateEvaluator<ProcessVariable> condition)

Description copied from interface: ConditionedProcessVariableSet

Method to define a custom condition and combine it conjunctively after its creation with existing one.

Specified by:

andShouldBe in interface ConditionedProcessVariableSet

Parameters:

condition - - Condition that is to be appended conjunctively

Returns:

Same step builder as this is not a stage transition.

thatAre

public ConstrainedProcessVariableSet thatAre(DescribedPredicateEvaluator<ProcessVariable> constraint)

Description copied from interface: ProcessVariableSet

Method to define a custom constraint.

Specified by:

thatAre in interface ProcessVariableSet

Parameters:

constraint - - Constraint that is fulfilled

Returns:

next step builder

orThatAre

public ProcessVariablePredicateBuilder<ConstrainedProcessVariableSet> orThatAre()

Description copied from interface: ConstrainedProcessVariableSet

Begins a predicate construction to define an additional constraint and combine it disjunctively after its creation with existing one.

Specified by:

orThatAre in interface ConstrainedProcessVariableSet

Returns:

First builder of predicate construction and specifying next stage of rule building with generic parameter.

andThatAre

public ProcessVariablePredicateBuilder<ConstrainedProcessVariableSet> andThatAre()

Description copied from interface: ConstrainedProcessVariableSet

Begins a predicate construction to define an additional constraint and combine it conjunctively after its creation with existing one.

Specified by:

andThatAre in interface ConstrainedProcessVariableSet

Returns:

First builder of predicate construction and specifying next stage of rule building with generic parameter.

orThatAre

public ConstrainedProcessVariableSet orThatAre(DescribedPredicateEvaluator<ProcessVariable> constraint)

Description copied from interface: ConstrainedProcessVariableSet

Method to define a custom constraint and combine it disjunctively after its creation with existing one.

Specified by:

orThatAre in interface ConstrainedProcessVariableSet

Parameters:

constraint - - Constraint to be appended disjunctively

Returns:

Same step builder as this is not a stage transition.

andThatAre

public ConstrainedProcessVariableSet andThatAre(DescribedPredicateEvaluator<ProcessVariable> constraint)

Description copied from interface: ConstrainedProcessVariableSet

Method to define a custom constraint and combine it conjunctively after its creation with existing one.

Specified by:

andThatAre in interface ConstrainedProcessVariableSet

Parameters:

constraint - - Constraint to be appended conjunctively

Returns:

Same step builder as this is not a stage transition.

thatAre

public ProcessVariablePredicateBuilder<ConstrainedProcessVariableSet> thatAre()

Description copied from interface: ProcessVariableSet

Begins a predicate construction to define a constraint.

Specified by:

thatAre in interface ProcessVariableSet

Returns:

First builder of predicate construction and specifying next stage of rule building with generic parameter.

check

public void check(Collection<ProcessVariable> variables)

Description copied from interface: DataFlowRule

Evaluates rule on the set of process variables. If at least one process variable violates the rule, an AssertionError is thrown including a rule description and listing rule violations.

Specified by:

check in interface DataFlowRule

Parameters:

variables - - process variables to evaluate rule on.

evaluate

public Collection<EvaluationResult<ProcessVariable>> evaluate(Collection<ProcessVariable> variables)

Description copied from interface: DataFlowRule

Evaluates rule on the set of process variables. EvaluationResult for each validated process variable is returned.

Specified by:

evaluate in interface DataFlowRule

Parameters:

variables - -process variables to evaluate rule on.

Returns:

Collection of EvalutionResults for variables

getRuleDescription

public String getRuleDescription()

Specified by:

getRuleDescription in interface DataFlowRule

getViolationMessageFor

public String getViolationMessageFor(EvaluationResult<ProcessVariable> result)

Specified by:

getViolationMessageFor in interface DataFlowRule

Parameters:

result - - EvaluationResult

Returns:

Violation message

getCriticality

public CriticalityEnum getCriticality()

Specified by:

getCriticality in interface DataFlowRule

because

public DataFlowRule because(String reason)

Description copied from interface: DataFlowRule

Method to define a reason.

Specified by:

because in interface DataFlowRule

Parameters:

reason - - Reason

Returns:

Same step builder as this is not a stage transition.

withCriticality

public DataFlowRule withCriticality(CriticalityEnum criticality)

Description copied from interface: DataFlowRule

Method to define criticality. Also implying issue type for vPAV validation.

Specified by:

withCriticality in interface DataFlowRule

Parameters:

criticality - - Criticality of rule

Returns:

Same step builder as this is not a stage transition.