org.hkijena.jipipe.api.data

Interface JIPipeSlotConfiguration

All Known Subinterfaces:

JIPipeMutableSlotConfiguration

All Known Implementing Classes:

JIPipeDefaultMutableSlotConfiguration, JIPipeIOSlotConfiguration

public interface JIPipeSlotConfiguration

A slot configuration determines which slots an JIPipeGraphNode should have. The algorithm then instantiates JIPipeDataSlot instances to match the configuration. This is required to allow multiple algorithms to share their slots.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JIPipeSlotConfiguration.Serializer Serializes the configuration
static class	JIPipeSlotConfiguration.SlotsChangedEvent Triggered when a JIPipeSlotConfiguration was changed

Method Summary

Modifier and Type	Method and Description
JIPipeSlotConfiguration	duplicate() Creates a deep copy
void	fromJson(com.fasterxml.jackson.databind.JsonNode jsonNode) Loads this configuration from JSON
EventBus	getEventBus()
List<String>	getInputSlotOrder()
Map<String,JIPipeDataSlotInfo>	getInputSlots()
List<String>	getOutputSlotOrder()
Map<String,JIPipeDataSlotInfo>	getOutputSlots()
default boolean	hasInputSlot(String name) Return true if there is an input slot with given name
default boolean	hasOutputSlot(String name) Return true if there is an output slot with given name
void	setTo(JIPipeSlotConfiguration configuration) Makes this slot configuration equivalent to the provided one
void	toJson(com.fasterxml.jackson.core.JsonGenerator generator) Saves this configuration to JSON.

Method Detail

duplicate

JIPipeSlotConfiguration duplicate()

Creates a deep copy

Returns:

a deep copy

getInputSlotOrder

List<String> getInputSlotOrder()

Returns:

the input slot order

getOutputSlotOrder

List<String> getOutputSlotOrder()

Returns:

the output slot order

getEventBus

EventBus getEventBus()

Returns:

the event bus

getInputSlots

Map<String,JIPipeDataSlotInfo> getInputSlots()

Returns:

the input slots

getOutputSlots

Map<String,JIPipeDataSlotInfo> getOutputSlots()

Returns:

the output slots

setTo

void setTo(JIPipeSlotConfiguration configuration)

Makes this slot configuration equivalent to the provided one

Parameters:

configuration - the configuration

fromJson

void fromJson(com.fasterxml.jackson.databind.JsonNode jsonNode)

Loads this configuration from JSON

Parameters:

jsonNode - JSON data

toJson

void toJson(com.fasterxml.jackson.core.JsonGenerator generator)
     throws IOException,
            com.fasterxml.jackson.core.JsonProcessingException

Saves this configuration to JSON.

Parameters:

generator - the Json generator

Throws:

com.fasterxml.jackson.core.JsonProcessingException - thrown by Json

IOException

hasInputSlot

default boolean hasInputSlot(String name)

Return true if there is an input slot with given name

Parameters:

name - the name

Returns:

if there is an input slot with given name

hasOutputSlot

default boolean hasOutputSlot(String name)

Return true if there is an output slot with given name

Parameters:

name - the name

Returns:

if there is an output slot with given name