Package com.inductiveautomation.eventstream.gateway.expression

Class GatewayEventStreamExpression

java.lang.Object

com.inductiveautomation.eventstream.gateway.expression.GatewayEventStreamExpression

All Implemented Interfaces:

EventStreamExpression

public class GatewayEventStreamExpression
extends Object
implements EventStreamExpression

Method Summary

Modifier and Type	Method	Description
static GatewayEventStreamExpression	create(EncoderRegistry encoders, CommonContext context, ExpressionValue field, String sourceHint)
QualifiedValue	evaluate(EventPayload any)	Evaluates the expression with the provided event.
<T> T	evaluateTyped(EventPayload event, Class<T> clazz)	Attempts to evaluate and coerce the express to a specific type.
void	shutdown()
String	sourceHint()	Unique key for identifying fields in diagnostics.
void	startup()

Methods inherited from class java.lang.Object

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

Method Details

create

public static GatewayEventStreamExpression create(EncoderRegistry encoders,
 CommonContext context,
 ExpressionValue field,
 String sourceHint)
                                           throws Exception

Throws:

Exception

sourceHint

public String sourceHint()

Description copied from interface: EventStreamExpression

Unique key for identifying fields in diagnostics.

Specified by:

sourceHint in interface EventStreamExpression

Returns:

Hint representing the field, typically will be the name of the field.

evaluate

public QualifiedValue evaluate(EventPayload any)
                        throws ExpressionException

Description copied from interface: EventStreamExpression

Evaluates the expression with the provided event.

Specified by:

evaluate in interface EventStreamExpression

Parameters:

any - Current event

Throws:

ExpressionException - When the expression fails to evaluate

evaluateTyped

public <T> T evaluateTyped(EventPayload event,
 Class<T> clazz)
                    throws IllegalArgumentException,
ExpressionException

Description copied from interface: EventStreamExpression

Attempts to evaluate and coerce the express to a specific type. Throws an exception if coercion isn't possible or the expression can't be evaluated.

Specified by:

evaluateTyped in interface EventStreamExpression

Parameters:

event - Current event

clazz - Type of class to coerce to

Throws:

IllegalArgumentException

ExpressionException

startup

public void startup()

shutdown

public void shutdown()