Package com.inductiveautomation.ignition.common.model

Class CommonContextDecorator

java.lang.Object

com.inductiveautomation.ignition.common.model.CommonContextDecorator

All Implemented Interfaces:

CommonContext

Direct Known Subclasses:

PerspectiveExpression.PerspectiveExpressionCommonContext

public abstract class CommonContextDecorator
extends java.lang.Object
implements CommonContext

Simple abstract decorator for CommonContext

Constructor Summary

Constructors

Constructor	Description
CommonContextDecorator(CommonContext delegate)

Method Summary

Modifier and Type	Method	Description
XMLDeserializer	createDeserializer()	Returns an instance of the XMLDeserializer that can be used to deserialize project resources.
java.util.List<EdgeEdition>	getEdgeEditions()	Returns a list of currently available Edge editions (either licensed or in trial).
com.google.common.eventbus.EventBus	getEventBus()	This is a generic event bus that can be used by any part of Ignition within a single scope (jvm)
FunctionFactory	getExpressionFunctionFactory()	Returns the core function factory used by expressions.
LicenseState	getLicenseState(java.lang.String moduleId)	Returns the license state for the given module
LogFilterSettings	getLoggingManager()
java.lang.Object	getModule(java.lang.String id)	Returns the hook class for another module, used for modules that deal with each other's models.
ScriptManager	getScriptManager()	Returns the ScriptManager that can be used to execute Python scripts.
TagManager	getTagManager()	Returns the manager that provides access to Ignition's tag system.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonContextDecorator

public CommonContextDecorator(@Nonnull
                              CommonContext delegate)

Method Detail

getTagManager

public TagManager getTagManager()

Description copied from interface: CommonContext

Returns the manager that provides access to Ignition's tag system.

Specified by:

getTagManager in interface CommonContext

getScriptManager

public ScriptManager getScriptManager()

Description copied from interface: CommonContext

Returns the ScriptManager that can be used to execute Python scripts.

Specified by:

getScriptManager in interface CommonContext

createDeserializer

public XMLDeserializer createDeserializer()

Description copied from interface: CommonContext

Returns an instance of the XMLDeserializer that can be used to deserialize project resources. Note that this is the only safe way to obtain an instance of XMLDeserializer, because the context will pass the new deserializer around to all loaded modules, giving them a chance to initialize any custom deserialization deletes on it first.

Specified by:

createDeserializer in interface CommonContext

getExpressionFunctionFactory

public FunctionFactory getExpressionFunctionFactory()

Description copied from interface: CommonContext

Returns the core function factory used by expressions. Includes extension functions registered by modules.

Specified by:

getExpressionFunctionFactory in interface CommonContext

getModule

public java.lang.Object getModule(java.lang.String id)

Description copied from interface: CommonContext

Returns the hook class for another module, used for modules that deal with each other's models. Example: The reporting plugin's designer hook uses this to get FactoryPMI's palette.

Specified by:

getModule in interface CommonContext

getLicenseState

public LicenseState getLicenseState(java.lang.String moduleId)

Description copied from interface: CommonContext

Returns the license state for the given module

Specified by:

getLicenseState in interface CommonContext

getEdgeEditions

public java.util.List<EdgeEdition> getEdgeEditions()

Description copied from interface: CommonContext

Returns a list of currently available Edge editions (either licensed or in trial). Does not check if any required modules are installed and running.

Specified by:

getEdgeEditions in interface CommonContext

getEventBus

public com.google.common.eventbus.EventBus getEventBus()

Description copied from interface: CommonContext

This is a generic event bus that can be used by any part of Ignition within a single scope (jvm)

Specified by:

getEventBus in interface CommonContext

getLoggingManager

public LogFilterSettings getLoggingManager()

Specified by:

getLoggingManager in interface CommonContext