Package com.inductiveautomation.ignition.gateway.alert

Class AbstractAlertExpressionContext

java.lang.Object

com.inductiveautomation.ignition.gateway.alert.AbstractAlertExpressionContext

All Implemented Interfaces:

ExpressionParseContext

public abstract class AbstractAlertExpressionContext
extends Object
implements ExpressionParseContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractAlertExpressionContext.AlertVariableExpression

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAlertExpressionContext(FunctionFactory funcFactory)

Method Summary

Modifier and Type	Method	Description
Expression	createBoundExpression(String path)	Much like the standard binder, but first checks to see if the path is an alert variable.
protected abstract Parser	createParser()
AlertMessage	getAlert()
FunctionFactory	getFunctionFactory()	Returns the function factory to be used for looking up functions during parsing.
Expression	parseExpression(String expr)
void	setAlert(AlertMessage alert)
void	setSecondaryParseContext(ExpressionParseContext context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractAlertExpressionContext

protected AbstractAlertExpressionContext(FunctionFactory funcFactory)

Method Details

createParser

protected abstract Parser createParser()

getAlert

public AlertMessage getAlert()

setAlert

public void setAlert(AlertMessage alert)

setSecondaryParseContext

public void setSecondaryParseContext(ExpressionParseContext context)

parseExpression

public Expression parseExpression(String expr)
                           throws Exception

Throws:

Exception

createBoundExpression

public Expression createBoundExpression(String path)
                                 throws RuntimeException

Much like the standard binder, but first checks to see if the path is an alert variable. Also, should ensure that that the resulting expression can be evaluated to a boolean.

Our variables are in the format of "[name|format]" where the "|format" is optional.

Specified by:

createBoundExpression in interface ExpressionParseContext

Parameters:

path - the text content inside the braces.

Returns:

the created Expression

Throws:

RuntimeException - if the expression cannot be created (e.g., invalid path)

getFunctionFactory

public FunctionFactory getFunctionFactory()

Description copied from interface: ExpressionParseContext

Returns the function factory to be used for looking up functions during parsing.

Specified by:

getFunctionFactory in interface ExpressionParseContext

Returns:

the FunctionFactory