Package com.inductiveautomation.perspective.gateway.binding.expression.structure

Class ExpressionStructureBinding

java.lang.Object

com.inductiveautomation.perspective.gateway.binding.expression.structure.ExpressionStructureBinding

All Implemented Interfaces:

ExpressionStructureBindingConstants, Binding

public class ExpressionStructureBinding
extends Object
implements Binding, ExpressionStructureBindingConstants

An ExpressionStructureBinding is a Binding where a given JSON document of any shape / size will have all its string value leaf nodes interpreted as expression sources

Field Summary

Fields inherited from interface com.inductiveautomation.perspective.gateway.api.Binding

BAD_CONFIG, BAD_REF, BIDIRECTIONAL_KEY, INITIAL_VALUE, MDC_BINDING_TARGET, NOT_FOUND

Fields inherited from interface com.inductiveautomation.perspective.common.config.constants.ExpressionStructureBindingConstants

TYPE_ID

Constructor Summary

Constructors

Constructor	Description
ExpressionStructureBinding(BindingContext bindingContext, BindingConfig bindingConfig, PerspectiveExpressionFactory exprFactory)

Method Summary

Modifier and Type	Method	Description
void	onUserRefresh()	Called to prompt the binding to produce a value as soon as possible.
Collection<PropertyReference>	resolveReferences()
void	shutdown()	Shut down the binding.
void	startup()	Start up the binding.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.perspective.gateway.api.Binding

isBidirectional, onTargetUpdated

Constructor Details

ExpressionStructureBinding

public ExpressionStructureBinding(@Nonnull
 BindingContext bindingContext,
 @Nonnull
 BindingConfig bindingConfig,
 @Nonnull
 PerspectiveExpressionFactory exprFactory)
                           throws ConfigurationException

Throws:

ConfigurationException

Method Details

resolveReferences

public Collection<PropertyReference> resolveReferences()

Specified by:

resolveReferences in interface Binding

startup

public void startup()

Description copied from interface: Binding

Start up the binding. Will be called on-queue

Specified by:

startup in interface Binding

shutdown

public void shutdown()

Description copied from interface: Binding

Shut down the binding. Will be called on-queue

Specified by:

shutdown in interface Binding

onUserRefresh

public void onUserRefresh()

Description copied from interface: Binding

Called to prompt the binding to produce a value as soon as possible. This _not_ the normal way that bindings work. Bindings are expected to produce a value un-prompted after startup, and then again whenever they feel is appropriate. This is there to allow the user to call component.refreshBinding(property) and prompt a non-polling binding to run.

Specified by:

onUserRefresh in interface Binding