Package org.drools.mvel.evaluators

Class OverlapsEvaluatorDefinition

  • All Implemented Interfaces:
    java.io.Externalizable, java.io.Serializable, org.drools.compiler.rule.builder.EvaluatorDefinition, org.kie.api.runtime.rule.EvaluatorDefinition
    public class OverlapsEvaluatorDefinition
extends java.lang.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 java.lang.String overlapsOp  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.drools.base.rule.accessor.Evaluator getEvaluator​(org.drools.base.base.ValueType type, java.lang.String operatorId, boolean isNegated, java.lang.String parameterText)  
      org.drools.base.rule.accessor.Evaluator getEvaluator​(org.drools.base.base.ValueType type, java.lang.String operatorId, boolean isNegated, java.lang.String parameterText, org.drools.compiler.rule.builder.EvaluatorDefinition.Target left, org.drools.compiler.rule.builder.EvaluatorDefinition.Target right)  
      org.drools.base.rule.accessor.Evaluator getEvaluator​(org.drools.base.base.ValueType type, org.drools.drl.parser.impl.Operator operator)  
      org.drools.base.rule.accessor.Evaluator getEvaluator​(org.drools.base.base.ValueType type, org.drools.drl.parser.impl.Operator operator, java.lang.String parameterText)  
      java.lang.String[] getEvaluatorIds()  
      org.drools.compiler.rule.builder.EvaluatorDefinition.Target getTarget()  
      boolean isNegatable()  
      void readExternal​(java.io.ObjectInput in)  
      boolean supportsType​(org.drools.base.base.ValueType type)  
      void writeExternal​(java.io.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 java.lang.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​(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
        Specified by:
        readExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException

      • writeExternal

        public void writeExternal​(java.io.ObjectOutput out)
                   throws java.io.IOException
        Specified by:
        writeExternal in interface java.io.Externalizable
        Throws:
        java.io.IOException

      • getEvaluator

        public org.drools.base.rule.accessor.Evaluator getEvaluator​(org.drools.base.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.base.rule.accessor.Evaluator getEvaluator​(org.drools.base.base.ValueType type,
                                                            org.drools.drl.parser.impl.Operator operator,
                                                            java.lang.String parameterText)
        Specified by:
        getEvaluator in interface org.drools.compiler.rule.builder.EvaluatorDefinition

      • getEvaluator

        public org.drools.base.rule.accessor.Evaluator getEvaluator​(org.drools.base.base.ValueType type,
                                                            java.lang.String operatorId,
                                                            boolean isNegated,
                                                            java.lang.String parameterText)
        Specified by:
        getEvaluator in interface org.drools.compiler.rule.builder.EvaluatorDefinition

      • getEvaluator

        public org.drools.base.rule.accessor.Evaluator getEvaluator​(org.drools.base.base.ValueType type,
                                                            java.lang.String operatorId,
                                                            boolean isNegated,
                                                            java.lang.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 java.lang.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.base.base.ValueType type)
        Specified by:
        supportsType in interface org.drools.compiler.rule.builder.EvaluatorDefinition