Package org.drools.mvel.evaluators

Class OverlapsEvaluatorDefinition

java.lang.Object

org.drools.mvel.evaluators.OverlapsEvaluatorDefinition

All Implemented Interfaces:

Externalizable, Serializable, org.drools.compiler.rule.builder.EvaluatorDefinition, org.kie.api.runtime.rule.EvaluatorDefinition

public class OverlapsEvaluatorDefinition
extends Object
implements org.drools.compiler.rule.builder.EvaluatorDefinition

The implementation of the overlaps evaluator definition.

The overlaps evaluator correlates two events and matches when the current event starts before the correlated event starts and finishes after the correlated event starts, but before the correlated event finishes. In other words, both events have an overlapping period.

Lets look at an example:

$eventA : EventA( this overlaps $eventB )

The previous pattern will match if and only if:

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

The overlaps operator accepts 1 or 2 optional parameters as follow:

• If one parameter is defined, this will be the maximum distance between the start timestamp of the correlated event and the end timestamp of the current event. Example:

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

Will match if and only if:

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

• If two values are defined, the first value will be the minimum distance and the second value will be the maximum distance between the start timestamp of the correlated event and the end timestamp of the current event. Example:

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

Will match if and only if:

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OverlapsEvaluatorDefinition.OverlapsEvaluator	Implements the 'overlaps' evaluator itself

Nested classes/interfaces inherited from interface org.drools.compiler.rule.builder.EvaluatorDefinition

org.drools.compiler.rule.builder.EvaluatorDefinition.Target

Field Summary

Fields

Modifier and Type	Field	Description
static org.drools.drl.parser.impl.Operator	OVERLAPS
static org.drools.drl.parser.impl.Operator	OVERLAPS_NOT
static String	overlapsOp

Constructor Summary

Constructors

Constructor	Description
OverlapsEvaluatorDefinition()

Method Summary

Modifier and Type	Method	Description
org.drools.core.rule.accessor.Evaluator	getEvaluator(org.drools.core.base.ValueType type, String operatorId, boolean isNegated, String parameterText)
org.drools.core.rule.accessor.Evaluator	getEvaluator(org.drools.core.base.ValueType type, String operatorId, boolean isNegated, String parameterText, org.drools.compiler.rule.builder.EvaluatorDefinition.Target left, org.drools.compiler.rule.builder.EvaluatorDefinition.Target right)
org.drools.core.rule.accessor.Evaluator	getEvaluator(org.drools.core.base.ValueType type, org.drools.drl.parser.impl.Operator operator)
org.drools.core.rule.accessor.Evaluator	getEvaluator(org.drools.core.base.ValueType type, org.drools.drl.parser.impl.Operator operator, String parameterText)
String[]	getEvaluatorIds()
org.drools.compiler.rule.builder.EvaluatorDefinition.Target	getTarget()
boolean	isNegatable()
void	readExternal(ObjectInput in)
boolean	supportsType(org.drools.core.base.ValueType 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

overlapsOp

public static final String overlapsOp

OVERLAPS

public static final org.drools.drl.parser.impl.Operator OVERLAPS

OVERLAPS_NOT

public static final org.drools.drl.parser.impl.Operator OVERLAPS_NOT

Constructor Detail

OverlapsEvaluatorDefinition

public OverlapsEvaluatorDefinition()

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 org.drools.core.rule.accessor.Evaluator getEvaluator(org.drools.core.base.ValueType type,
                                                            org.drools.drl.parser.impl.Operator operator)

Specified by:

getEvaluator in interface org.drools.compiler.rule.builder.EvaluatorDefinition

getEvaluator

public org.drools.core.rule.accessor.Evaluator getEvaluator(org.drools.core.base.ValueType type,
                                                            org.drools.drl.parser.impl.Operator operator,
                                                            String parameterText)

Specified by:

getEvaluator in interface org.drools.compiler.rule.builder.EvaluatorDefinition

getEvaluator

public org.drools.core.rule.accessor.Evaluator getEvaluator(org.drools.core.base.ValueType type,
                                                            String operatorId,
                                                            boolean isNegated,
                                                            String parameterText)

Specified by:

getEvaluator in interface org.drools.compiler.rule.builder.EvaluatorDefinition

getEvaluator

public org.drools.core.rule.accessor.Evaluator getEvaluator(org.drools.core.base.ValueType type,
                                                            String operatorId,
                                                            boolean isNegated,
                                                            String parameterText,
                                                            org.drools.compiler.rule.builder.EvaluatorDefinition.Target left,
                                                            org.drools.compiler.rule.builder.EvaluatorDefinition.Target right)

Specified by:

getEvaluator in interface org.drools.compiler.rule.builder.EvaluatorDefinition

getEvaluatorIds

public String[] getEvaluatorIds()

Specified by:

getEvaluatorIds in interface org.drools.compiler.rule.builder.EvaluatorDefinition

isNegatable

public boolean isNegatable()

Specified by:

isNegatable in interface org.drools.compiler.rule.builder.EvaluatorDefinition

getTarget

public org.drools.compiler.rule.builder.EvaluatorDefinition.Target getTarget()

Specified by:

getTarget in interface org.drools.compiler.rule.builder.EvaluatorDefinition

supportsType

public boolean supportsType(org.drools.core.base.ValueType type)

Specified by:

supportsType in interface org.drools.compiler.rule.builder.EvaluatorDefinition