Package org.drools.mvel.evaluators

Class FinishedByEvaluatorDefinition

java.lang.Object

org.drools.mvel.evaluators.FinishedByEvaluatorDefinition

All Implemented Interfaces:

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

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

The implementation of the finishedby evaluator definition.

The finishedby evaluator correlates two events and matches when the current event start timestamp happens before the correlated event start timestamp, but both end timestamps occur at the same time. This is the symmetrical opposite of finishes evaluator.

Lets look at an example:

$eventA : EventA( this finishedby $eventB )

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

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

The finishedby evaluator accepts one optional parameter. If it is defined, it determines the maximum distance between the end timestamp of both events in order for the operator to match. Example:

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

Will match if and only if:

 
 $eventA.startTimestamp < $eventB.startTimestamp &&
 abs( $eventA.endTimestamp - $eventB.endTimestamp ) <= 5s
 

NOTE: it makes no sense to use a negative interval value for the parameter and the engine will raise an exception if that happens.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FinishedByEvaluatorDefinition.FinishedByEvaluator	Implements the 'finishedby' 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	FINISHED_BY
protected static String	finishedByOp
static org.drools.drl.parser.impl.Operator	NOT_FINISHED_BY

Constructor Summary

Constructors

Constructor	Description
FinishedByEvaluatorDefinition()

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

finishedByOp

protected static final String finishedByOp

FINISHED_BY

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

NOT_FINISHED_BY

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

Constructor Detail

FinishedByEvaluatorDefinition

public FinishedByEvaluatorDefinition()

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