org.drools.base.evaluators
Class SetEvaluatorsDefinition

java.lang.Object
  extended by org.drools.base.evaluators.SetEvaluatorsDefinition
All Implemented Interfaces:
Externalizable, Serializable, org.drools.runtime.rule.EvaluatorDefinition

public class SetEvaluatorsDefinition
extends Object
implements EvaluatorDefinition

This class defines all the set built in evaluators like contains, memberOf, etc.

See Also:
Serialized Form

Nested Class Summary
static interface SetEvaluatorsDefinition.ArrayContains
           
static class SetEvaluatorsDefinition.ArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.ArrayExcludesEvaluator
           
static class SetEvaluatorsDefinition.BaseMemberOfEvaluator
           
static class SetEvaluatorsDefinition.BaseNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.BigDecimalMemberOfEvaluator
           
static class SetEvaluatorsDefinition.BigDecimalNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.BigIntegerMemberOfEvaluator
           
static class SetEvaluatorsDefinition.BigIntegerNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.BooleanArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.BooleanMemberOfEvaluator
           
static class SetEvaluatorsDefinition.BooleanNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.ByteArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.ByteMemberOfEvaluator
           
static class SetEvaluatorsDefinition.ByteNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.CharacterMemberOfEvaluator
           
static class SetEvaluatorsDefinition.CharacterNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.CharArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.DateMemberOfEvaluator
           
static class SetEvaluatorsDefinition.DateNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.DoubleArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.DoubleMemberOfEvaluator
           
static class SetEvaluatorsDefinition.DoubleNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.FloatArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.FloatMemberOfEvaluator
           
static class SetEvaluatorsDefinition.FloatNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.IntegerArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.IntegerMemberOfEvaluator
           
static class SetEvaluatorsDefinition.IntegerNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.LongArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.LongMemberOfEvaluator
           
static class SetEvaluatorsDefinition.LongNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.ObjectArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.ObjectContainsEvaluator
           
static class SetEvaluatorsDefinition.ObjectExcludesEvaluator
           
static class SetEvaluatorsDefinition.ObjectMemberOfEvaluator
           
static class SetEvaluatorsDefinition.ObjectNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.ShortArrayContainsEvaluator
           
static class SetEvaluatorsDefinition.ShortMemberOfEvaluator
           
static class SetEvaluatorsDefinition.ShortNotMemberOfEvaluator
           
static class SetEvaluatorsDefinition.StringMemberOfEvaluator
           
static class SetEvaluatorsDefinition.StringNotMemberOfEvaluator
           
 
Nested classes/interfaces inherited from interface org.drools.base.evaluators.EvaluatorDefinition
EvaluatorDefinition.Target
 
Field Summary
static Operator CONTAINS
           
static Operator EXCLUDES
           
static Operator MEMBEROF
           
static Operator NOT_CONTAINS
           
static Operator NOT_EXCLUDES
           
static Operator NOT_MEMBEROF
           
 
Constructor Summary
SetEvaluatorsDefinition()
           
 
Method Summary
static SetEvaluatorsDefinition.ArrayContains getArrayContains(Class cls)
           
 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

CONTAINS

public static final Operator CONTAINS

NOT_CONTAINS

public static final Operator NOT_CONTAINS

EXCLUDES

public static final Operator EXCLUDES

NOT_EXCLUDES

public static final Operator NOT_EXCLUDES

MEMBEROF

public static final Operator MEMBEROF

NOT_MEMBEROF

public static final Operator NOT_MEMBEROF
Constructor Detail

SetEvaluatorsDefinition

public SetEvaluatorsDefinition()
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:

getArrayContains

public static SetEvaluatorsDefinition.ArrayContains getArrayContains(Class cls)


Copyright © 2001-2012 JBoss by Red Hat. All Rights Reserved.