Package com.inductiveautomation.perspective.gateway.binding.transforms.map

Class AbstractMapTransform

java.lang.Object

com.inductiveautomation.perspective.gateway.binding.transforms.AbstractSynchronousTransform

com.inductiveautomation.perspective.gateway.binding.transforms.map.AbstractMapTransform

All Implemented Interfaces:

Transform

public abstract class AbstractMapTransform
extends AbstractSynchronousTransform

Base class for a Map Transform. Handles thread-safe scheduling of its MappingCollection's updates and is the liaison between the BindingContext and the MappingCollection.

Field Summary

Fields

Modifier and Type	Field	Description
protected BindingContext	context
protected MappingElement	fallback

Method Summary

Modifier and Type	Method	Description
boolean	isReady()	Used for unit tests to see if this tranfsorm is ready immediately after startup or if it is required to wait until bindingContext.processPublishedValue is called for the first time.
void	shutdown()	Shutdown hook called by the AbstractBindingHarness.
void	startup()	Startup hook called by the AbstractBindingHarness.
protected QualifiedValue	synchronousTransformInternal(QualifiedValue value)	Perform a blocking transformation on a QualifiedValue, returning the transformed value as a QualifiedValue.

Methods inherited from class com.inductiveautomation.perspective.gateway.binding.transforms.AbstractSynchronousTransform

transform

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final BindingContext context

fallback

protected final MappingElement fallback

Method Detail

startup

public void startup()

Description copied from interface: Transform

Startup hook called by the AbstractBindingHarness. This method will run on the SessionContext's ExecutionQueue thread. The default implementation is a no-op.

isReady

public boolean isReady()

Used for unit tests to see if this tranfsorm is ready immediately after startup or if it is required to wait until bindingContext.processPublishedValue is called for the first time.

shutdown

public void shutdown()

Description copied from interface: Transform

Shutdown hook called by the AbstractBindingHarness. This method will run on the SessionContext's ExecutionQueue thread. The default implementation is a no-op.

synchronousTransformInternal

protected QualifiedValue synchronousTransformInternal(@Nonnull
                                                      QualifiedValue value)

Description copied from class: AbstractSynchronousTransform

Perform a blocking transformation on a QualifiedValue, returning the transformed value as a QualifiedValue.

Specified by:

synchronousTransformInternal in class AbstractSynchronousTransform

Parameters:

value - The input value to transform. The value will never be null.

Returns:

The transformed value.