org.hkijena.jipipe.plugins.parameters.api.graph

Class SlotMapParameterCollection

java.lang.Object

org.hkijena.jipipe.api.parameters.JIPipeDynamicParameterCollection

org.hkijena.jipipe.plugins.parameters.api.graph.SlotMapParameterCollection

All Implemented Interfaces:

JIPipeGraphNode.NodeSlotsChangedEventListener, JIPipeCustomParameterCollection, JIPipeCustomTextDescriptionParameter, JIPipeParameterCollection, JIPipeValidatable, JsonDeserializable

Direct Known Subclasses:

InputSlotMapParameterCollection, OutputSlotMapParameterCollection

public abstract class SlotMapParameterCollection
extends JIPipeDynamicParameterCollection
implements JIPipeGraphNode.NodeSlotsChangedEventListener

Parameter that holds a value for each data slot

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
SlotMapParameterCollection(Class<?> dataClass, JIPipeGraphNode node, Function<JIPipeDataSlotInfo,Object> newInstanceGenerator, boolean initialize) Creates a new instance

Method Summary

Modifier and Type	Method and Description
Class<?>	getDataClass()
Function<JIPipeDataSlotInfo,Object>	getNewInstanceGenerator()
JIPipeGraphNode	getNode()
Predicate<JIPipeDataSlot>	getSlotFilter()
void	onNodeSlotsChanged(JIPipeGraphNode.NodeSlotsChangedEvent event) Triggered when algorithm slots are changed
void	setNewInstanceGenerator(Function<JIPipeDataSlotInfo,Object> newInstanceGenerator)
void	setSlotFilter(Predicate<JIPipeDataSlot> slotFilter)
abstract void	updateSlots() Method that adds missing entries, or removes invalid entries based on the algorithm's slot configuration

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

SlotMapParameterCollection

public SlotMapParameterCollection(Class<?> dataClass,
                                  JIPipeGraphNode node,
                                  Function<JIPipeDataSlotInfo,Object> newInstanceGenerator,
                                  boolean initialize)

Creates a new instance

Parameters:

dataClass - the data type of the parameter assigned to each slot

node - the algorithm that contains the slots

newInstanceGenerator - optional method that generated new instances. Can be null

initialize - If true, update the slots on creation

Method Detail

getSlotFilter

public Predicate<JIPipeDataSlot> getSlotFilter()

setSlotFilter

public void setSlotFilter(Predicate<JIPipeDataSlot> slotFilter)

getNode

public JIPipeGraphNode getNode()

getDataClass

public Class<?> getDataClass()

updateSlots

public abstract void updateSlots()

Method that adds missing entries, or removes invalid entries based on the algorithm's slot configuration

onNodeSlotsChanged

public void onNodeSlotsChanged(JIPipeGraphNode.NodeSlotsChangedEvent event)

Triggered when algorithm slots are changed

Specified by:

onNodeSlotsChanged in interface JIPipeGraphNode.NodeSlotsChangedEventListener

Parameters:

event - generated event

getNewInstanceGenerator

public Function<JIPipeDataSlotInfo,Object> getNewInstanceGenerator()

setNewInstanceGenerator

public void setNewInstanceGenerator(Function<JIPipeDataSlotInfo,Object> newInstanceGenerator)