/*
* Copyright 2010 JBoss Inc
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.drools.core.base.evaluators;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import org.drools.core.RuntimeDroolsException;
import org.drools.core.base.BaseEvaluator;
import org.drools.core.base.ValueType;
import org.drools.core.common.EventFactHandle;
import org.drools.core.common.InternalFactHandle;
import org.drools.core.common.InternalWorkingMemory;
import org.drools.core.rule.VariableRestriction.TemporalVariableContextEntry;
import org.drools.core.rule.VariableRestriction.VariableContextEntry;
import org.drools.core.spi.Evaluator;
import org.drools.core.spi.FieldValue;
import org.drools.core.spi.InternalReadAccessor;
import org.drools.core.time.Interval;
/**
* <p>The implementation of the <code>finishes</code> evaluator definition.</p>
*
* <p>The <b><code>finishes</code></b> evaluator correlates two events and matches when the current event's
* start timestamp happens after the correlated event's start timestamp, but both end timestamps occur at
* the same time.</p>
*
* <p>Lets look at an example:</p>
*
* <pre>$eventA : EventA( this finishes $eventB )</pre>
*
* <p>The previous pattern will match if and only if the $eventA starts after $eventB starts and finishes
* at the same time $eventB finishes. In other words:</p>
*
* <pre>
* $eventB.startTimestamp < $eventA.startTimestamp &&
* $eventA.endTimestamp == $eventB.endTimestamp
* </pre>
*
* <p>The <b><code>finishes</code></b> 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:</p>
*
* <pre>$eventA : EventA( this finishes[ 5s ] $eventB )</pre>
*
* Will match if and only if:
*
* <pre>
* $eventB.startTimestamp < $eventA.startTimestamp &&
* abs( $eventA.endTimestamp - $eventB.endTimestamp ) <= 5s
* </pre>
*
* <p><b>NOTE:</b> it makes no sense to use a negative interval value for the parameter and the
* engine will raise an exception if that happens.</p>
*/
public class FinishesEvaluatorDefinition
implements
EvaluatorDefinition {
protected static final String finishesOp = "finishes";
public static Operator FINISHES;
public static Operator FINISHES_NOT;
private static String[] SUPPORTED_IDS;
private Map<String, FinishesEvaluator> cache = Collections.emptyMap();
private volatile TimeIntervalParser parser = new TimeIntervalParser();
{ init(); }
static void init() {
if ( Operator.determineOperator( finishesOp, false ) == null ) {
FINISHES = Operator.addOperatorToRegistry( finishesOp, false );
FINISHES_NOT = Operator.addOperatorToRegistry( finishesOp, true );
SUPPORTED_IDS = new String[] { finishesOp };
}
}
@SuppressWarnings("unchecked")
public void readExternal(ObjectInput in) throws IOException,
ClassNotFoundException {
cache = (Map<String, FinishesEvaluator>) in.readObject();
}
public void writeExternal(ObjectOutput out) throws IOException {
out.writeObject( cache );
}
/**
* @inheridDoc
*/
public Evaluator getEvaluator(ValueType type,
Operator operator) {
return this.getEvaluator( type,
operator.getOperatorString(),
operator.isNegated(),
null );
}
/**
* @inheridDoc
*/
public Evaluator getEvaluator(ValueType type,
Operator operator,
String parameterText) {
return this.getEvaluator( type,
operator.getOperatorString(),
operator.isNegated(),
parameterText );
}
/**
* @inheritDoc
*/
public Evaluator getEvaluator(final ValueType type,
final String operatorId,
final boolean isNegated,
final String parameterText) {
return this.getEvaluator( type,
operatorId,
isNegated,
parameterText,
Target.HANDLE,
Target.HANDLE );
}
/**
* @inheritDoc
*/
public Evaluator getEvaluator(final ValueType type,
final String operatorId,
final boolean isNegated,
final String parameterText,
final Target left,
final Target right ) {
if ( this.cache == Collections.EMPTY_MAP ) {
this.cache = new HashMap<String, FinishesEvaluator>();
}
String key = isNegated + ":" + parameterText;
FinishesEvaluator eval = this.cache.get( key );
if ( eval == null ) {
Long[] params = parser.parse( parameterText );
eval = new FinishesEvaluator( type,
isNegated,
params,
parameterText );
this.cache.put( key,
eval );
}
return eval;
}
/**
* @inheritDoc
*/
public String[] getEvaluatorIds() {
return SUPPORTED_IDS;
}
/**
* @inheritDoc
*/
public boolean isNegatable() {
return true;
}
/**
* @inheritDoc
*/
public Target getTarget() {
return Target.HANDLE;
}
/**
* @inheritDoc
*/
public boolean supportsType(ValueType type) {
// supports all types, since it operates over fact handles
// Note: should we change this interface to allow checking of event classes only?
return true;
}
/**
* Implements the 'finishes' evaluator itself
*/
public static class FinishesEvaluator extends BaseEvaluator {
private static final long serialVersionUID = 510l;
private long endDev;
private String paramText;
{
FinishesEvaluatorDefinition.init();
}
public FinishesEvaluator() {
}
public FinishesEvaluator(final ValueType type,
final boolean isNegated,
final Long[] parameters,
final String paramText) {
super( type,
isNegated ? FINISHES_NOT : FINISHES );
this.paramText = paramText;
this.setParameters( parameters );
}
public void readExternal(ObjectInput in) throws IOException,
ClassNotFoundException {
super.readExternal( in );
endDev = in.readLong();
paramText = (String) in.readObject();
}
public void writeExternal(ObjectOutput out) throws IOException {
super.writeExternal( out );
out.writeLong( endDev );
out.writeObject( paramText );
}
@Override
public boolean isTemporal() {
return true;
}
@Override
public Interval getInterval() {
if ( this.getOperator().isNegated() ) {
return new Interval( Interval.MIN,
Interval.MAX );
}
return new Interval( 0,
Interval.MAX );
}
public boolean evaluate(InternalWorkingMemory workingMemory,
final InternalReadAccessor extractor,
final InternalFactHandle object1,
final FieldValue object2) {
throw new RuntimeDroolsException( "The 'finishes' operator can only be used to compare one event to another, and never to compare to literal constraints." );
}
public boolean evaluateCachedRight(InternalWorkingMemory workingMemory,
final VariableContextEntry context,
final InternalFactHandle left) {
if ( context.rightNull ||
context.declaration.getExtractor().isNullValue( workingMemory, left.getObject() )) {
return false;
}
long distStart = ((TemporalVariableContextEntry) context).startTS - ((EventFactHandle) left).getStartTimestamp();
long distEnd = Math.abs( ((EventFactHandle) left).getEndTimestamp() -((TemporalVariableContextEntry) context).endTS );
return this.getOperator().isNegated() ^ (distStart > 0 && distEnd <= this.endDev);
}
public boolean evaluateCachedLeft(InternalWorkingMemory workingMemory,
final VariableContextEntry context,
final InternalFactHandle right) {
if ( context.leftNull ||
context.extractor.isNullValue( workingMemory, right.getObject() ) ) {
return false;
}
long distStart = ((EventFactHandle) right).getStartTimestamp() - ((TemporalVariableContextEntry) context).startTS;
long distEnd = Math.abs( ((TemporalVariableContextEntry) context).endTS - ((EventFactHandle) right).getEndTimestamp() );
return this.getOperator().isNegated() ^ (distStart > 0 && distEnd <= this.endDev);
}
public boolean evaluate(InternalWorkingMemory workingMemory,
final InternalReadAccessor extractor1,
final InternalFactHandle handle1,
final InternalReadAccessor extractor2,
final InternalFactHandle handle2) {
if ( extractor1.isNullValue( workingMemory, handle1.getObject() ) ||
extractor2.isNullValue( workingMemory, handle2.getObject() ) ) {
return false;
}
long distStart = ((EventFactHandle) handle1).getStartTimestamp() - ((EventFactHandle) handle2).getStartTimestamp();
long distEnd = Math.abs( ((EventFactHandle) handle2).getEndTimestamp() - ((EventFactHandle) handle1).getEndTimestamp() );
return this.getOperator().isNegated() ^ (distStart > 0 && distEnd <= this.endDev);
}
public String toString() {
return "finishes[" + ((paramText != null) ? paramText : "") + "]";
}
/* (non-Javadoc)
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
final int PRIME = 31;
int result = super.hashCode();
result = PRIME * result + (int) (endDev ^ (endDev >>> 32));
return result;
}
/* (non-Javadoc)
* @see java.lang.Object#equals(java.lang.Object)
*/
@Override
public boolean equals(Object obj) {
if ( this == obj ) return true;
if ( !super.equals( obj ) ) return false;
if ( getClass() != obj.getClass() ) return false;
final FinishesEvaluator other = (FinishesEvaluator) obj;
return endDev == other.endDev;
}
/**
* This methods sets the parameters appropriately.
*
* @param parameters
*/
private void setParameters(Long[] parameters) {
if ( parameters == null || parameters.length == 0 ) {
this.endDev = 0;
} else if ( parameters.length == 1 ) {
if( parameters[0].longValue() >= 0 ) {
// defined deviation for end timestamp
this.endDev = parameters[0].longValue();
} else {
throw new RuntimeDroolsException("[Finishes Evaluator]: Not possible to use negative parameter: '" + paramText + "'");
}
} else {
throw new RuntimeDroolsException( "[Finishes Evaluator]: Not possible to use " + parameters.length + " parameters: '" + paramText + "'" );
}
}
}
}