org.hkijena.jipipe.api.nodes

Annotation Type JIPipeInputSlot

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Repeatable(value=JIPipeInputSlots.class)
public @interface JIPipeInputSlot

Annotates an JIPipeGraphNode with an input slot.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<? extends JIPipeData>	value The data class

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoCreate If true, JIPipeGraphNode automatically configures its slots based on annotations (unless a custom JIPipeSlotConfiguration is provided.
String	description An optional description.
boolean	optional If true, the input is considered optional.
JIPipeDataSlotRole	role Assigns a role to the slot for internal usage within the node's code.
String	slotName An optional slot name.

Element Detail

value

public abstract Class<? extends JIPipeData> value

The data class

Returns:

data class

slotName

public abstract String slotName

An optional slot name. Cannot be empty if autoCreate is true.

Returns:

slot name

Default:

""

description

public abstract String description

An optional description.

Returns:

slot description

Default:

""

autoCreate

public abstract boolean autoCreate

If true, JIPipeGraphNode automatically configures its slots based on annotations (unless a custom JIPipeSlotConfiguration is provided.

Returns:

if auto-configuration is enabled

Default:

false

optional

public abstract boolean optional

If true, the input is considered optional. The node will still run without a connection to the input (with an empty data table)

Returns:

if the input is optional

Default:

false

role

public abstract JIPipeDataSlotRole role

Assigns a role to the slot for internal usage within the node's code. For example, this allows to distinguish data and parametric inputs from each other

Returns:

the role. Leave at Data if there is no special role.

Default:

org.hkijena.jipipe.api.data.JIPipeDataSlotRole.Data