org.processmining.datapetrinets.expression

Interface GuardExpression

All Known Implementing Classes:

AbstractGuardExpression

public interface GuardExpression

A guard expression defined over some set of variables. Please use the GuardExpression.Factory methods to obtain an instance. You may use the GuardExpression.Operation methods to compose expressions. The syntax for guard expressions is defined in 'expression.jjt' in the package org.processmining.datapetrinets.expression.syntax..

Please note, this class was previously part of the DataPetriNets package. That is why it uses the package name 'datapetrinets'.

Author:

F. Mannhardt

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GuardExpression.Factory Standard way of creating GuardExpression instances
static class	GuardExpression.Operation Operations that mutate, combine, etc.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	evaluate(java.util.Map<java.lang.String,java.lang.Object> valueMap)
java.lang.Object	evaluate(VariableProvider variableProvider)
java.lang.Object	evaluate(VariableProvider variableProvider, FunctionProvider functionProvider)
<T> java.util.Set<T>	getLiteralValues(java.lang.Class<T> type)
java.util.Set<java.lang.String>	getNormalVariables()
java.util.Set<java.lang.String>	getPrimeVariables() Returns the list of prime variable identifiers (x' is the prime version of x).
boolean	isFalse()
boolean	isFalse(java.util.Map<java.lang.String,java.lang.Object> valueMap)
boolean	isFalse(VariableProvider variableProvider)
boolean	isFalse(VariableProvider variableProvider, FunctionProvider functionProvider)
boolean	isTrue()
boolean	isTrue(java.util.Map<java.lang.String,java.lang.Object> valueMap)
boolean	isTrue(VariableProvider variableProvider)
boolean	isTrue(VariableProvider variableProvider, FunctionProvider functionProvider)
java.lang.String	toCanonicalString()
java.lang.String	toPrettyString(int spaces)
java.lang.String	toTreeLikeString(int indent)
java.lang.Object	visit(ExpressionParserVisitor visitor, java.lang.Object data)

Method Detail

visit

java.lang.Object visit(ExpressionParserVisitor visitor,
                       java.lang.Object data)
                throws ExpressionVisitorException

Throws:

ExpressionVisitorException

evaluate

java.lang.Object evaluate(VariableProvider variableProvider,
                          FunctionProvider functionProvider)
                   throws EvaluatorException

Throws:

EvaluatorException

evaluate

java.lang.Object evaluate(VariableProvider variableProvider)
                   throws EvaluatorException

Throws:

EvaluatorException

evaluate

java.lang.Object evaluate(java.util.Map<java.lang.String,java.lang.Object> valueMap)
                   throws EvaluatorException

Throws:

EvaluatorException

isTrue

boolean isTrue(VariableProvider variableProvider,
               FunctionProvider functionProvider)
        throws EvaluatorException

Throws:

EvaluatorException

isTrue

boolean isTrue(VariableProvider variableProvider)
        throws EvaluatorException

Throws:

EvaluatorException

isTrue

boolean isTrue(java.util.Map<java.lang.String,java.lang.Object> valueMap)
        throws EvaluatorException

Throws:

EvaluatorException

isTrue

boolean isTrue()
        throws EvaluatorException

Returns:

whether the expression is always true, returns false in case variables are used

Throws:

EvaluatorException - never

isFalse

boolean isFalse(VariableProvider variableProvider,
                FunctionProvider functionProvider)
         throws EvaluatorException

Throws:

EvaluatorException

isFalse

boolean isFalse(VariableProvider variableProvider)
         throws EvaluatorException

Throws:

EvaluatorException

isFalse

boolean isFalse(java.util.Map<java.lang.String,java.lang.Object> valueMap)
         throws EvaluatorException

Throws:

EvaluatorException

isFalse

boolean isFalse()
         throws EvaluatorException

Returns:

whether the expression is always false, returns false in case variables are used

Throws:

EvaluatorException - never

getNormalVariables

java.util.Set<java.lang.String> getNormalVariables()

Returns:

the list of normal (non-prime) variables

getPrimeVariables

java.util.Set<java.lang.String> getPrimeVariables()

Returns the list of prime variable identifiers (x' is the prime version of x). The variable identifiers are returned without the prime symbol (x instead of x' would be returned).

Returns:

the list of prime variables

getLiteralValues

<T> java.util.Set<T> getLiteralValues(java.lang.Class<T> type)

toCanonicalString

java.lang.String toCanonicalString()

toPrettyString

java.lang.String toPrettyString(int spaces)

toTreeLikeString

java.lang.String toTreeLikeString(int indent)