org.hkijena.jipipe.extensions.expressions

Class CustomExpressionVariablesParameter

java.lang.Object

org.hkijena.jipipe.api.parameters.JIPipeDynamicParameterCollection

org.hkijena.jipipe.extensions.expressions.CustomExpressionVariablesParameter

All Implemented Interfaces:

JIPipeValidatable, JIPipeCustomParameterCollection, JIPipeParameterCollection, JsonDeserializable

public class CustomExpressionVariablesParameter
extends JIPipeDynamicParameterCollection

A parameter collection that allows the creation of custom expression variables Please note that the JIPipeParameter annotation should have JIPipeParameterPersistence set to 'NestedCollection'. Otherwise, user-defined parameters will not be saved!

Nested Class Summary

Nested classes/interfaces inherited from class org.hkijena.jipipe.api.parameters.JIPipeDynamicParameterCollection

JIPipeDynamicParameterCollection.Deserializer, JIPipeDynamicParameterCollection.ParameterAddingEvent, JIPipeDynamicParameterCollection.UserParameterDefinition

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
CustomExpressionVariablesParameter()
CustomExpressionVariablesParameter(CustomExpressionVariablesParameter other)
CustomExpressionVariablesParameter(CustomExpressionVariablesParameter other, JIPipeGraphNode target)
CustomExpressionVariablesParameter(JIPipeGraphNode target)

Method Summary

Modifier and Type	Method and Description
void	writeToVariables(ExpressionVariables variables, boolean asVariables, String variablesPrefix, boolean toMap, String mapName) Writes the parameter values to variables

Methods inherited from class org.hkijena.jipipe.api.parameters.JIPipeDynamicParameterCollection

addParameter, addParameter, addParameter, beginModificationBlock, clear, containsKey, copyTo, endModificationBlock, fromJson, get, getAllowedTypes, getEventBus, getInstanceGenerator, getParameter, getParameters, getValue, isAllowUserModification, removeParameter, reportValidity, setAllowedTypes, setAllowUserModification, setInstanceGenerator, setValue, supportsAllParameterTypes

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeCustomParameterCollection

getChildParameterCollections, getIncludeReflectionParameters

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Methods inherited from interface org.hkijena.jipipe.api.JIPipeValidatable

generateValidityReport

Constructor Detail

CustomExpressionVariablesParameter

public CustomExpressionVariablesParameter()

CustomExpressionVariablesParameter

public CustomExpressionVariablesParameter(JIPipeGraphNode target)

CustomExpressionVariablesParameter

public CustomExpressionVariablesParameter(CustomExpressionVariablesParameter other)

CustomExpressionVariablesParameter

public CustomExpressionVariablesParameter(CustomExpressionVariablesParameter other,
                                          JIPipeGraphNode target)

Method Detail

writeToVariables

public void writeToVariables(ExpressionVariables variables,
                             boolean asVariables,
                             String variablesPrefix,
                             boolean toMap,
                             String mapName)

Writes the parameter values to variables

Parameters:

variables - the target

asVariables - write as variables (accessible via the key)

variablesPrefix - prefix for the variables

toMap - if a map should be created (accessible via the key)

mapName - the name of the map