org.hkijena.jipipe.plugins.expressions.custom

Class JIPipeCustomExpressionVariablesParameter

java.lang.Object

org.hkijena.jipipe.api.parameters.JIPipeDynamicParameterCollection

org.hkijena.jipipe.plugins.expressions.custom.JIPipeCustomExpressionVariablesParameter

All Implemented Interfaces:

JIPipeCustomParameterCollection, JIPipeCustomTextDescriptionParameter, JIPipeParameterCollection, JIPipeValidatable, JsonDeserializable

public class JIPipeCustomExpressionVariablesParameter
extends JIPipeDynamicParameterCollection

A parameter collection that allows the creation of custom expression variables Please note that the JIPipeParameter annotation should have JIPipeParameterSerializationMode 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.BeforeAddParameterEvent, JIPipeDynamicParameterCollection.BeforeAddParameterEventEmitter, JIPipeDynamicParameterCollection.BeforeAddParameterEventListener, JIPipeDynamicParameterCollection.Deserializer, JIPipeDynamicParameterCollection.UserParameterDefinition

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Constructor Summary

Constructors

Constructor and Description
JIPipeCustomExpressionVariablesParameter()
JIPipeCustomExpressionVariablesParameter(AbstractJIPipeParameterCollection target)
JIPipeCustomExpressionVariablesParameter(JIPipeCustomExpressionVariablesParameter other)
JIPipeCustomExpressionVariablesParameter(JIPipeCustomExpressionVariablesParameter other, AbstractJIPipeParameterCollection target)

Method Summary

Modifier and Type	Method and Description
void	writeToVariables(JIPipeExpressionVariablesMap variables) Writes the parameter values to variables with default configuration
void	writeToVariables(JIPipeExpressionVariablesMap 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, getBeforeAddParameterEventEmitter, getInstanceGenerator, getParameter, getParameterChangedEventEmitter, getParameters, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, getTextDescription, 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

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

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

generateValidityReport

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

getTextDescriptionOf

Constructor Detail

JIPipeCustomExpressionVariablesParameter

public JIPipeCustomExpressionVariablesParameter()

JIPipeCustomExpressionVariablesParameter

public JIPipeCustomExpressionVariablesParameter(AbstractJIPipeParameterCollection target)

JIPipeCustomExpressionVariablesParameter

public JIPipeCustomExpressionVariablesParameter(JIPipeCustomExpressionVariablesParameter other)

JIPipeCustomExpressionVariablesParameter

public JIPipeCustomExpressionVariablesParameter(JIPipeCustomExpressionVariablesParameter other,
                                                AbstractJIPipeParameterCollection target)

Method Detail

writeToVariables

public void writeToVariables(JIPipeExpressionVariablesMap 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

writeToVariables

public void writeToVariables(JIPipeExpressionVariablesMap variables)

Writes the parameter values to variables with default configuration

Parameters:

variables - the target