org.drools.core.base.evaluators

Class IncludesEvaluatorDefinition

java.lang.Object

org.drools.core.base.evaluators.IncludesEvaluatorDefinition

All Implemented Interfaces:

Externalizable, Serializable, org.kie.api.runtime.rule.EvaluatorDefinition

public class IncludesEvaluatorDefinition
extends Object
implements EvaluatorDefinition

The implementation of the includes evaluator definition.

The includes evaluator correlates two events and matches when the event being correlated happens during the current event. It is the symmetrical opposite of during evaluator.

Lets look at an example:

$eventA : EventA( this includes $eventB )

The previous pattern will match if and only if the $eventB starts after $eventA starts and finishes before $eventA finishes. In other words:

 $eventA.startTimestamp < $eventB.startTimestamp <= $eventB.endTimestamp < $eventA.endTimestamp 

The includes operator accepts 1, 2 or 4 optional parameters as follow:

• If one value is defined, this will be the maximum distance between the start timestamp of both event and the maximum distance between the end timestamp of both events in order to operator match. Example:

$eventA : EventA( this includes[ 5s ] $eventB )

Will match if and only if:

 
 0 < $eventB.startTimestamp - $eventA.startTimestamp <= 5s &&
 0 < $eventA.endTimestamp - $eventB.endTimestamp <= 5s
 

• If two values are defined, the first value will be the minimum distance between the timestamps of both events, while the second value will be the maximum distance between the timestamps of both events. Example:

$eventA : EventA( this includes[ 5s, 10s ] $eventB )

Will match if and only if:

 
 5s <= $eventB.startTimestamp - $eventA.startTimestamp <= 10s &&
 5s <= $eventA.endTimestamp - $eventB.endTimestamp <= 10s
 

• If four values are defined, the first two values will be the minimum and maximum distances between the start timestamp of both events, while the last two values will be the minimum and maximum distances between the end timestamp of both events. Example:

$eventA : EventA( this includes[ 2s, 6s, 4s, 10s ] $eventB )

Will match if and only if:

 
 2s <= $eventB.startTimestamp - $eventA.startTimestamp <= 6s &&
 4s <= $eventA.endTimestamp - $eventB.endTimestamp <= 10s
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IncludesEvaluatorDefinition.IncludesEvaluator Implements the 'includes' evaluator itself

Nested classes/interfaces inherited from interface org.drools.core.base.evaluators.EvaluatorDefinition

EvaluatorDefinition.Target

Field Summary

Fields

Modifier and Type	Field and Description
static Operator	INCLUDES
static Operator	INCLUDES_NOT
static String	includesOp

Constructor Summary

Constructors

Constructor and Description
IncludesEvaluatorDefinition()

Method Summary

Modifier and Type	Method and Description
Evaluator	getEvaluator(ValueType type, Operator operator) Returns the evaluator instance for the given type and the defined parameterText
Evaluator	getEvaluator(ValueType type, Operator operator, String parameterText) Returns the evaluator instance for the given type and the defined parameterText
Evaluator	getEvaluator(ValueType type, String operatorId, boolean isNegated, String parameterText) Returns the evaluator instance for the given type and the defined parameterText
Evaluator	getEvaluator(ValueType type, String operatorId, boolean isNegated, String parameterText, EvaluatorDefinition.Target left, EvaluatorDefinition.Target right) Returns the evaluator instance for the given type and the defined parameterText
String[]	getEvaluatorIds() Returns the list of identifies this evaluator implementation supports
EvaluatorDefinition.Target	getTarget() There are evaluators that operate on *fact* attributes, evaluators that operate on *fact handle* attributes, and evaluators that operate on both.
boolean	isNegatable() My apologies to English speakers if the word "negatable" does not exist. :) This method returns true if this evaluator supports negation.
void	readExternal(ObjectInput in)
boolean	supportsType(ValueType type) Returns true in case this evaluator supports operations over values of that specific type.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

includesOp

public static final String includesOp

See Also:

Constant Field Values

INCLUDES

public static Operator INCLUDES

INCLUDES_NOT

public static Operator INCLUDES_NOT

Constructor Detail

IncludesEvaluatorDefinition

public IncludesEvaluatorDefinition()

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getEvaluator

public Evaluator getEvaluator(ValueType type,
                              Operator operator)

Description copied from interface: EvaluatorDefinition

Returns the evaluator instance for the given type and the defined parameterText

Parameters:

type - the type of the attributes this evaluator will operate on. This is important because the evaluator may do optimisations and type coercion based on the types it is evaluating. It is also possible that this evaluator does not support a given type.

operator - the operator implemented by the evaluator

Returns:

an Evaluator instance capable of evaluating expressions between values of the given type, or null in case the type is not supported.

getEvaluator

public Evaluator getEvaluator(ValueType type,
                              Operator operator,
                              String parameterText)

Description copied from interface: EvaluatorDefinition

Returns the evaluator instance for the given type and the defined parameterText

Parameters:

type - the type of the attributes this evaluator will operate on. This is important because the evaluator may do optimisations and type coercion based on the types it is evaluating. It is also possible that this evaluator does not support a given type.

operator - the operator implemented by the evaluator

parameterText - some evaluators support parameters and these parameters are defined as a String that is parsed by the evaluator itself.

Returns:

an Evaluator instance capable of evaluating expressions between values of the given type, or null in case the type is not supported.

getEvaluator

public Evaluator getEvaluator(ValueType type,
                              String operatorId,
                              boolean isNegated,
                              String parameterText)

Description copied from interface: EvaluatorDefinition

Returns the evaluator instance for the given type and the defined parameterText

Parameters:

type - the type of the attributes this evaluator will operate on. This is important because the evaluator may do optimisations and type coercion based on the types it is evaluating. It is also possible that this evaluator does not support a given type.

operatorId - the string identifier of the evaluator

isNegated - true if the evaluator instance to be returned is the negated version of the evaluator.

parameterText - some evaluators support parameters and these parameters are defined as a String that is parsed by the evaluator itself.

Returns:

an Evaluator instance capable of evaluating expressions between values of the given type, or null in case the type is not supported.

getEvaluator

public Evaluator getEvaluator(ValueType type,
                              String operatorId,
                              boolean isNegated,
                              String parameterText,
                              EvaluatorDefinition.Target left,
                              EvaluatorDefinition.Target right)

Description copied from interface: EvaluatorDefinition

Returns the evaluator instance for the given type and the defined parameterText

Parameters:

type - the type of the attributes this evaluator will operate on. This is important because the evaluator may do optimisations and type coercion based on the types it is evaluating. It is also possible that this evaluator does not support a given type.

operatorId - the string identifier of the evaluator

isNegated - true if the evaluator instance to be returned is the negated version of the evaluator.

parameterText - some evaluators support parameters and these parameters are defined as a String that is parsed by the evaluator itself.

left - the target of the evaluator on the Left side, i.e., on Rete terms, the previous binding or the actual value on the right side of the operator.

right - the target of the evaluator on the Right side, i.e., on Rete terms, the current pattern field.

Returns:

an Evaluator instance capable of evaluating expressions between values of the given type, or null in case the type is not supported.

getEvaluatorIds

public String[] getEvaluatorIds()

Description copied from interface: EvaluatorDefinition

Returns the list of identifies this evaluator implementation supports

Returns:

isNegatable

public boolean isNegatable()

Description copied from interface: EvaluatorDefinition

My apologies to English speakers if the word "negatable" does not exist. :) This method returns true if this evaluator supports negation. Example: the "matches" operator supports "not matches" and so is "negatable" (!?)

Returns:

getTarget

public EvaluatorDefinition.Target getTarget()

Description copied from interface: EvaluatorDefinition

There are evaluators that operate on *fact* attributes, evaluators that operate on *fact handle* attributes, and evaluators that operate on both. This method returns the target of the current evaluator.

Returns:

true if this evaluator operates on fact handle attributes and false if it operates on fact attributes

supportsType

public boolean supportsType(ValueType type)

Description copied from interface: EvaluatorDefinition

Returns true in case this evaluator supports operations over values of that specific type.

Returns: