org.hkijena.jipipe.api.data

Class JIPipeDataSlotInfo

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.data.JIPipeDataSlotInfo

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener

public class JIPipeDataSlotInfo
extends AbstractJIPipeParameterCollection

Defines an JIPipeGraphNode data slot. This class is used within JIPipeSlotConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDataSlotInfo.Deserializer Deserializes an JIPipeDataSlotInfo
static class	JIPipeDataSlotInfo.Serializer Serializes an JIPipeDataSlotInfo

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

Modifier	Constructor and Description
protected	JIPipeDataSlotInfo()
	JIPipeDataSlotInfo(AddJIPipeInputSlot slot)
	JIPipeDataSlotInfo(AddJIPipeOutputSlot slot)
	JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass, JIPipeSlotType slotType)
	JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass, JIPipeSlotType slotType, String name, String description)
	JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass, JIPipeSlotType slotType, String name, String description, boolean optional)
	JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass, JIPipeSlotType slotType, String name, String description, String inheritedSlot) Deprecated. inheritedSlot is deprecated and non-functional
	JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass, JIPipeSlotType slotType, String name, String description, String inheritedSlot, boolean optional) Deprecated. inheritedSlot is deprecated and non-functional
	JIPipeDataSlotInfo(JIPipeDataSlotInfo other) Copies the definition

Method Summary

Modifier and Type	Method and Description
void	copyMetadata(JIPipeDataSlotInfo other) Copies additional parameters such as custom names from the other slot
JIPipeDataSlot	createInstance(JIPipeGraphNode node)
boolean	equals(Object o)
String	getCustomName()
Class<? extends JIPipeData>	getDataClass()
String	getDescription()
String	getName()
JIPipeDataSlotRole	getRole()
JIPipeSlotType	getSlotType()
int	hashCode()
boolean	isInput()
boolean	isOptional()
boolean	isOutput()
boolean	isStoreToDisk()
boolean	isUserModifiable() Additional control variable to make a slot not removable/editable.
static boolean	isValidName(String slotName) Returns true if the provided string is a valid slot name
boolean	isVirtual()
JIPipeDataSlotInfo	renamedCopy(String newName)
void	setCustomName(String customName) Overrides the name displayed in the UI
void	setDataClass(Class<? extends JIPipeData> dataClass)
void	setDescription(String description)
void	setOptional(boolean optional)
void	setRole(JIPipeDataSlotRole role)
void	setStoreToDisk(boolean storeToDisk)
void	setUserModifiable(boolean userModifiable) Set this variable to make a slot not removable/editable.
void	setVirtual(boolean virtual)
AddJIPipeInputSlot	toInputSlotAnnotation() Converts this info into the annotation form.
AddJIPipeOutputSlot	toOutputSlotAnnotation() Converts this info into the annotation form.

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

Constructor Detail

JIPipeDataSlotInfo

protected JIPipeDataSlotInfo()

JIPipeDataSlotInfo

@Deprecated
public JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass,
                                      JIPipeSlotType slotType,
                                      String name,
                                      String description,
                                      String inheritedSlot,
                                      boolean optional)

Deprecated. inheritedSlot is deprecated and non-functional

Parameters:

dataClass - slot data class

slotType - slot type

name - unique slot name

description - description of the slot

inheritedSlot - deprecated

optional - only relevant if an input slot. marks the slot as optional input if true

JIPipeDataSlotInfo

@Deprecated
public JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass,
                                      JIPipeSlotType slotType,
                                      String name,
                                      String description,
                                      String inheritedSlot)

Deprecated. inheritedSlot is deprecated and non-functional

Parameters:

dataClass - slot data class

slotType - slot type

name - unique slot name

description - description of the slot

inheritedSlot - only relevant if output slot. Can be an input slot name or '*' to automatically select the first input slot

JIPipeDataSlotInfo

public JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass,
                          JIPipeSlotType slotType,
                          String name,
                          String description,
                          boolean optional)

JIPipeDataSlotInfo

public JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass,
                          JIPipeSlotType slotType,
                          String name,
                          String description)

Parameters:

dataClass - slot data class

slotType - slot type

name - unique slot name

description - description of the slot

JIPipeDataSlotInfo

public JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass,
                          JIPipeSlotType slotType)

Parameters:

dataClass - slot data class

slotType - slot type

JIPipeDataSlotInfo

public JIPipeDataSlotInfo(AddJIPipeInputSlot slot)

Parameters:

slot - Imported annotation

JIPipeDataSlotInfo

public JIPipeDataSlotInfo(AddJIPipeOutputSlot slot)

Parameters:

slot - Imported annotation

JIPipeDataSlotInfo

public JIPipeDataSlotInfo(JIPipeDataSlotInfo other)

Copies the definition

Parameters:

other - The original

Method Detail

isValidName

public static boolean isValidName(String slotName)

Returns true if the provided string is a valid slot name

Parameters:

slotName - the name

Returns:

if the name is valid

toInputSlotAnnotation

public AddJIPipeInputSlot toInputSlotAnnotation()

Converts this info into the annotation form. Throws an UnsupportedOperationException if the info describes an output.

Returns:

the annotation

toOutputSlotAnnotation

public AddJIPipeOutputSlot toOutputSlotAnnotation()

Converts this info into the annotation form. Throws an UnsupportedOperationException if the info describes an output.

Returns:

the annotation

createInstance

public JIPipeDataSlot createInstance(JIPipeGraphNode node)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

isInput

public boolean isInput()

isOutput

public boolean isOutput()

renamedCopy

public JIPipeDataSlotInfo renamedCopy(String newName)

Parameters:

newName - new name

Returns:

Slot definition copy with new name

getDataClass

public Class<? extends JIPipeData> getDataClass()

setDataClass

public void setDataClass(Class<? extends JIPipeData> dataClass)

getSlotType

public JIPipeSlotType getSlotType()

getName

public String getName()

getCustomName

public String getCustomName()

Returns:

A custom name that the UI is displaying instead of getName() if the return value is not null or empty

setCustomName

public void setCustomName(String customName)

Overrides the name displayed in the UI

Parameters:

customName - a custom name or null to reset the custom name

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

isVirtual

public boolean isVirtual()

setVirtual

public void setVirtual(boolean virtual)

isStoreToDisk

public boolean isStoreToDisk()

setStoreToDisk

public void setStoreToDisk(boolean storeToDisk)

isOptional

public boolean isOptional()

setOptional

public void setOptional(boolean optional)

isUserModifiable

public boolean isUserModifiable()

Additional control variable to make a slot not removable/editable. Use this to have "internal" slots that should never be removed. This property is not serialized! The node must set it via code!

Returns:

if the slot is removable/editable

setUserModifiable

public void setUserModifiable(boolean userModifiable)

Set this variable to make a slot not removable/editable. This property is not serialized! The node must set it via code!

Parameters:

userModifiable - if the slot is removable/editable

copyMetadata

public void copyMetadata(JIPipeDataSlotInfo other)

Copies additional parameters such as custom names from the other slot

Parameters:

other - other slot

getRole

public JIPipeDataSlotRole getRole()

setRole

public void setRole(JIPipeDataSlotRole role)