Package com.inductiveautomation.ignition.gateway.expressions

Class TagReferenceBinder

java.lang.Object

com.inductiveautomation.ignition.gateway.expressions.TagReferenceBinder

All Implemented Interfaces:

ExpressionParseContext

Direct Known Subclasses:

TagReferenceBinder.ReadBinder, TagReferenceBinder.SubscribedBinder

public abstract class TagReferenceBinder
extends Object
implements ExpressionParseContext

The TagReferenceBinder is a parse context that looks for references to tags, and possibly properties. There are three possible binder types: Subscribed, and Read, and Subscribed Prop or Tag, created with the new{Type}Binder() functions.

The subscribed binder will subscribe to tags it encounters and fire interaction events when the values change. The read binder will read the tag values when executed, but will not know when they change otherwise.

The prop or tag binder will try to determine if the reference is to a property or a tag, based on syntax. For a tag reference to be created in this case, the path must be "this" or start with "[source]" (relative source is fine).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TagReferenceBinder.ReadBinder
protected static class	TagReferenceBinder.SubscribedBinder
protected static class	TagReferenceBinder.SubscribedTagExpression
protected static class	TagReferenceBinder.TagReadExpression

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TagReferenceBinder(ObservablePropertySource propSource, FunctionFactory funcFactory, TagPath basePath)
protected	TagReferenceBinder(FunctionFactory funcFactory, TagPath basePath)
protected	TagReferenceBinder(FunctionFactory funFact, Supplier<String> defaultProvider)

Method Summary

Modifier and Type	Method	Description
Expression	createBoundExpression(String path)	Called to create expressions to represent bound elements, like:
FunctionFactory	getFunctionFactory()
protected LoggerEx	getLogger()
protected Expression	instantiatePropertyExpression(Property<?> prop)
protected abstract Expression	instantiateTagExpression(TagPath path, boolean selfRef)
protected boolean	isTag(String path)
protected boolean	isThis(String path)
static TagReferenceBinder	newReadBinder(FunctionFactory funFact, Supplier<String> defaultProvider)
static TagReferenceBinder	newReadBinder(TagPath basePath, FunctionFactory funcFactory)
static TagReferenceBinder	newSubscribedBinder(TagPath basePath, FunctionFactory funcFactory)	Returns a reference binder that subscribes to tag paths inside of it.
static TagReferenceBinder	newTagOrPropertyBinder(ObservablePropertySource properties, TagPath basePath, FunctionFactory funcFactory)
void	setThrowExceptionOnParseError(boolean throwExceptionOnParseError)

Methods inherited from class java.lang.Object

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

Constructor Details

TagReferenceBinder

protected TagReferenceBinder(ObservablePropertySource propSource,
 FunctionFactory funcFactory,
 TagPath basePath)

TagReferenceBinder

protected TagReferenceBinder(FunctionFactory funFact,
 Supplier<String> defaultProvider)

TagReferenceBinder

protected TagReferenceBinder(FunctionFactory funcFactory,
 TagPath basePath)

Method Details

newTagOrPropertyBinder

public static TagReferenceBinder newTagOrPropertyBinder(ObservablePropertySource properties,
 TagPath basePath,
 FunctionFactory funcFactory)

newSubscribedBinder

public static TagReferenceBinder newSubscribedBinder(TagPath basePath,
 FunctionFactory funcFactory)

Returns a reference binder that subscribes to tag paths inside of it.

newReadBinder

public static TagReferenceBinder newReadBinder(TagPath basePath,
 FunctionFactory funcFactory)

newReadBinder

public static TagReferenceBinder newReadBinder(FunctionFactory funFact,
 Supplier<String> defaultProvider)

getLogger

protected LoggerEx getLogger()

getFunctionFactory

public FunctionFactory getFunctionFactory()

Specified by:

getFunctionFactory in interface ExpressionParseContext

instantiatePropertyExpression

protected Expression instantiatePropertyExpression(Property<?> prop)

instantiateTagExpression

protected abstract Expression instantiateTagExpression(TagPath path,
 boolean selfRef)

isThis

protected boolean isThis(String path)

isTag

protected boolean isTag(String path)

createBoundExpression

public Expression createBoundExpression(String path)
                                 throws RuntimeException

Description copied from interface: ExpressionParseContext

Called to create expressions to represent bound elements, like:

 { path.to.something }
 

Specified by:

createBoundExpression in interface ExpressionParseContext

Parameters:

path - the text content inside the braces.

Throws:

RuntimeException - because the CUP parser doesn't have a throws on the function that calls this inside the parser

setThrowExceptionOnParseError

public void setThrowExceptionOnParseError(boolean throwExceptionOnParseError)