Package org.openhab.core.automation.module.script

Class ScriptTransformationService

java.lang.Object

org.openhab.core.automation.module.script.ScriptTransformationService

All Implemented Interfaces:

ScriptDependencyTracker.Listener, RegistryChangeListener<Transformation>, ConfigDescriptionProvider, ConfigOptionProvider, TransformationService

@NonNullByDefault
public class ScriptTransformationService
extends Object
implements TransformationService, ScriptDependencyTracker.Listener, ConfigOptionProvider, ConfigDescriptionProvider, RegistryChangeListener<Transformation>

The ScriptTransformationService implements a TransformationService using any available script language

Author:

Jan N. Klug - Initial contribution, Florian Hotze - Implement script dependency tracking

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OPENHAB_TRANSFORMATION_SCRIPT
static final String	SCRIPT_TYPE_PROPERTY_NAME

Fields inherited from interface org.openhab.core.transform.TransformationService

SERVICE_PROPERTY_LABEL, SERVICE_PROPERTY_NAME, TRANSFORM_FOLDER_NAME, TRANSFORM_PROFILE_SCOPE

Constructor Summary

Constructors

Constructor	Description
ScriptTransformationService(TransformationRegistry transformationRegistry, ConfigDescriptionRegistry configDescRegistry, ScriptEngineManager scriptEngineManager, Map<String,Object> config)

Method Summary

Modifier and Type	Method	Description
void	added(Transformation element)	Notifies the listener that a single element has been added.
void	deactivate()
@Nullable ConfigDescription	getConfigDescription(URI uri, @Nullable Locale locale)	Provides a ConfigDescription for the given URI.
Collection<ConfigDescription>	getConfigDescriptions(@Nullable Locale locale)	Provides a collection of ConfigDescriptions.
@Nullable Collection<ParameterOption>	getParameterOptions(URI uri, String param, @Nullable String context, @Nullable Locale locale)	Provides a collection of ParameterOptions.
void	onDependencyChange(String scriptId)	Called by the dependency tracker when a registered dependency changes
void	removed(Transformation element)	Notifies the listener that a single element has been removed.
@Nullable String	transform(String function, String source)	Transforms the input source by means of the given function and returns the transformed output.
void	updated(Transformation oldElement, Transformation element)	Notifies the listener that a single element has been updated.

Methods inherited from class java.lang.Object

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

Field Details

SCRIPT_TYPE_PROPERTY_NAME

public static final String SCRIPT_TYPE_PROPERTY_NAME

See Also:

• Constant Field Values

OPENHAB_TRANSFORMATION_SCRIPT

public static final String OPENHAB_TRANSFORMATION_SCRIPT

See Also:

• Constant Field Values

Constructor Details

ScriptTransformationService

public ScriptTransformationService(TransformationRegistry transformationRegistry,
 ConfigDescriptionRegistry configDescRegistry,
 ScriptEngineManager scriptEngineManager,
 Map<String,Object> config)

Method Details

deactivate

public void deactivate()

transform

public @Nullable String transform(String function,
 String source)
                           throws TransformationException

Description copied from interface: TransformationService

Transforms the input source by means of the given function and returns the transformed output. The transformation may return null to express its operation resulted in a null output. In case of any error a TransformationException should be thrown.

Specified by:

transform in interface TransformationService

Parameters:

function - the function to be used to transform the input

source - the input to be transformed

Returns:

the transformed result or null if the transformation's output is null.

Throws:

TransformationException - if any error occurs

added

public void added(Transformation element)

Description copied from interface: RegistryChangeListener

Notifies the listener that a single element has been added.

Specified by:

added in interface RegistryChangeListener<Transformation>

Parameters:

element - the element that has been added

removed

public void removed(Transformation element)

Description copied from interface: RegistryChangeListener

Notifies the listener that a single element has been removed.

Specified by:

removed in interface RegistryChangeListener<Transformation>

Parameters:

element - the element that has been removed

updated

public void updated(Transformation oldElement,
 Transformation element)

Description copied from interface: RegistryChangeListener

Notifies the listener that a single element has been updated.

Specified by:

updated in interface RegistryChangeListener<Transformation>

Parameters:

oldElement - the element that has been updated

element - the new element

getParameterOptions

public @Nullable Collection<ParameterOption> getParameterOptions(URI uri,
 String param,
 @Nullable String context,
 @Nullable Locale locale)

Description copied from interface: ConfigOptionProvider

Provides a collection of ParameterOptions.

Specified by:

getParameterOptions in interface ConfigOptionProvider

Parameters:

uri - the uri of the config description

param - the parameter name for which the requested options shall be returned

context - the defined context of the parameter

locale - the locale in which the result is expected

Returns:

the configuration options provided by this provider if any or null otherwise

getConfigDescriptions

public Collection<ConfigDescription> getConfigDescriptions(@Nullable Locale locale)

Description copied from interface: ConfigDescriptionProvider

Provides a collection of ConfigDescriptions.

Specified by:

getConfigDescriptions in interface ConfigDescriptionProvider

Parameters:

locale - locale

Returns:

the configuration descriptions provided by this provider (not null, could be empty)

getConfigDescription

public @Nullable ConfigDescription getConfigDescription(URI uri,
 @Nullable Locale locale)

Description copied from interface: ConfigDescriptionProvider

Provides a ConfigDescription for the given URI.

Specified by:

getConfigDescription in interface ConfigDescriptionProvider

Parameters:

uri - uri of the config description

locale - locale

Returns:

config description or null if no config description could be found

onDependencyChange

public void onDependencyChange(String scriptId)

Description copied from interface: ScriptDependencyTracker.Listener

Called by the dependency tracker when a registered dependency changes

Specified by:

onDependencyChange in interface ScriptDependencyTracker.Listener

Parameters:

scriptId - the identifier of the script whose dependency changed