org.hkijena.jipipe.plugins.expressions

Class JIPipeExpressionVariablesMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

org.hkijena.jipipe.plugins.expressions.JIPipeExpressionVariablesMap

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class JIPipeExpressionVariablesMap
extends HashMap<String,Object>

Object that carries variables for expressions

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
JIPipeExpressionVariablesMap()
JIPipeExpressionVariablesMap(JIPipeAlgorithm node)
JIPipeExpressionVariablesMap(JIPipeExpressionVariablesMap other)
JIPipeExpressionVariablesMap(JIPipeMultiIterationStep iterationStep)
JIPipeExpressionVariablesMap(JIPipeSingleIterationStep iterationStep)

Method Summary

Modifier and Type	Method and Description
JIPipeExpressionVariablesMap	putAnnotations(List<JIPipeTextAnnotation> textAnnotations) Puts annotations into the variables
JIPipeExpressionVariablesMap	putAnnotations(Map<String,JIPipeTextAnnotation> mergedTextAnnotations) Puts annotations into the variables
JIPipeExpressionVariablesMap	putAnnotationsIfAbsent(Collection<JIPipeTextAnnotation> textAnnotations)
JIPipeExpressionVariablesMap	putCommonVariables(JIPipeAlgorithm node)
JIPipeExpressionVariablesMap	putCommonVariables(JIPipeMultiIterationStep iterationStep)
JIPipeExpressionVariablesMap	putCommonVariables(JIPipeSingleIterationStep iterationStep)
JIPipeExpressionVariablesMap	putCustomVariables(JIPipeCustomExpressionVariablesParameter customExpressionVariablesParameter) Puts custom expression parameters (with default settings)
JIPipeExpressionVariablesMap	putGlobalVariables(JIPipeProject project)
JIPipeExpressionVariablesMap	putProjectDirectories(Path projectDir, Map<String,Path> projectDataDirs) Puts the project-related directories into the variables
JIPipeExpressionVariablesMap	set(String variableName, Object value) Sets a variable value.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

JIPipeExpressionVariablesMap

public JIPipeExpressionVariablesMap()

JIPipeExpressionVariablesMap

public JIPipeExpressionVariablesMap(JIPipeExpressionVariablesMap other)

JIPipeExpressionVariablesMap

public JIPipeExpressionVariablesMap(JIPipeSingleIterationStep iterationStep)

JIPipeExpressionVariablesMap

public JIPipeExpressionVariablesMap(JIPipeMultiIterationStep iterationStep)

JIPipeExpressionVariablesMap

public JIPipeExpressionVariablesMap(JIPipeAlgorithm node)

Method Detail

set

public JIPipeExpressionVariablesMap set(String variableName,
                                        Object value)

Sets a variable value.

Parameters:

variableName - The variable name

value - The variable value (null to remove a variable from the set).

Returns:

this

putAnnotations

public JIPipeExpressionVariablesMap putAnnotations(Map<String,JIPipeTextAnnotation> mergedTextAnnotations)

Puts annotations into the variables

Parameters:

mergedTextAnnotations - the annotations

putAnnotations

public JIPipeExpressionVariablesMap putAnnotations(List<JIPipeTextAnnotation> textAnnotations)

Puts annotations into the variables

Parameters:

textAnnotations - the annotations

Returns:

this

putProjectDirectories

public JIPipeExpressionVariablesMap putProjectDirectories(Path projectDir,
                                                          Map<String,Path> projectDataDirs)

Puts the project-related directories into the variables

Parameters:

projectDir - the project dir

projectDataDirs - project data dirs

Returns:

this

putCustomVariables

public JIPipeExpressionVariablesMap putCustomVariables(JIPipeCustomExpressionVariablesParameter customExpressionVariablesParameter)

Puts custom expression parameters (with default settings)

Parameters:

customExpressionVariablesParameter - the parameter

Returns:

this

putAnnotationsIfAbsent

public JIPipeExpressionVariablesMap putAnnotationsIfAbsent(Collection<JIPipeTextAnnotation> textAnnotations)

putGlobalVariables

public JIPipeExpressionVariablesMap putGlobalVariables(JIPipeProject project)

putCommonVariables

public JIPipeExpressionVariablesMap putCommonVariables(JIPipeSingleIterationStep iterationStep)

putCommonVariables

public JIPipeExpressionVariablesMap putCommonVariables(JIPipeMultiIterationStep iterationStep)

putCommonVariables

public JIPipeExpressionVariablesMap putCommonVariables(JIPipeAlgorithm node)