Package com.inductiveautomation.perspective.gateway.binding.property

Class PropertyBinding

java.lang.Object

com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

com.inductiveautomation.perspective.gateway.binding.AbstractBinding

com.inductiveautomation.perspective.gateway.binding.property.PropertyBinding

All Implemented Interfaces:

PropertyBindingConstants, Binding

public class PropertyBinding
extends AbstractBinding
implements PropertyBindingConstants

Field Summary

Fields inherited from class com.inductiveautomation.perspective.gateway.binding.AbstractBinding

bindingContext

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

BAD_CONFIG, BAD_REF, BIDIRECTIONAL_KEY, COALESCE_KEY, INITIAL_VALUE, MDC_BINDING_TARGET, NOT_FOUND

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

CONFIG_SOURCE_PATH, TYPE_ID

Constructor Summary

Constructors

Constructor	Description
PropertyBinding(BindingContext bindingContext, BindingConfig bindingConfig)

Method Summary

Modifier and Type	Method	Description
boolean	isBidirectional()
protected void	onShutdown()
protected void	onStartup()
void	onTargetPropertyChanged(QualifiedValue newTargetValue)
void	onUserRefresh()	Called to prompt the binding to produce a value as soon as possible.
Collection<PropertyReference>	resolveReferences()
boolean	shouldCoalesce()

Methods inherited from class com.inductiveautomation.perspective.gateway.binding.AbstractBinding

onTargetUpdated

Methods inherited from class com.inductiveautomation.ignition.common.lifecycle.AbstractLifecycle

isRunning, shutdown, startup

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

shutdown, startup

Constructor Details

PropertyBinding

public PropertyBinding(BindingContext bindingContext,
 BindingConfig bindingConfig)
                throws ConfigurationException

Throws:

ConfigurationException

Method Details

isBidirectional

public boolean isBidirectional()

Specified by:

isBidirectional in interface Binding

Returns:

true if this binding wants to be bidirectional. Note that if any transforms are present, then the binding will not operate in a bidirectional way.

shouldCoalesce

public boolean shouldCoalesce()

Specified by:

shouldCoalesce in interface Binding

Returns:

true if this binding wants to be bidirectional. Note that if any transforms are present, then the binding will not operate in a bidirectional way.

resolveReferences

public Collection<PropertyReference> resolveReferences()

Specified by:

resolveReferences in interface Binding

onStartup

protected void onStartup()

Specified by:

onStartup in class AbstractLifecycle

onTargetPropertyChanged

public void onTargetPropertyChanged(QualifiedValue newTargetValue)

Overrides:

onTargetPropertyChanged in class AbstractBinding

onShutdown

protected void onShutdown()

Specified by:

onShutdown in class AbstractLifecycle

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