org.hkijena.jipipe.api.data

Class JIPipeDataSlotInfo

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeDataSlotInfo

All Implemented Interfaces:

JIPipeParameterCollection

public class JIPipeDataSlotInfo
extends Object
implements JIPipeParameterCollection

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.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JIPipeDataSlotInfo()
	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, String inheritedSlot)
	JIPipeDataSlotInfo(Class<? extends JIPipeData> dataClass, JIPipeSlotType slotType, String name, String description, String inheritedSlot, boolean optional)
	JIPipeDataSlotInfo(JIPipeDataSlotInfo other) Copies the definition
	JIPipeDataSlotInfo(JIPipeInputSlot slot)
	JIPipeDataSlotInfo(JIPipeOutputSlot slot)

Method Summary

Modifier and Type	Method and Description
static Class<? extends JIPipeData>	applyInheritanceConversion(JIPipeDataSlotInfo definition, Class<? extends JIPipeData> dataClass) Applies inheritance conversion.
static Map<JIPipeDataInfo,JIPipeDataInfo>	composeInheritanceConversions(Map<JIPipeDataInfo,JIPipeDataInfo> outer, Map<JIPipeDataInfo,JIPipeDataInfo> inner) Creates the composition of two inheritance conversions.
static Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>>	composeRawInheritanceConversions(Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> outer, Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> inner) Creates the composition of two inheritance conversions.
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()
EventBus	getEventBus() Gets the event bus that posts events about the parameters
Map<JIPipeDataInfo,JIPipeDataInfo>	getInheritanceConversions()
String	getInheritedSlot() Gets slot to inherit the data type from If null or empty, this slot does not inherit If it equals '*', the first available input slot is chosen
String	getName()
JIPipeDataSlotRole	getRole()
JIPipeSlotType	getSlotType()
int	hashCode()
boolean	isInput()
boolean	isOptional()
boolean	isOutput()
boolean	isSaveOutputs()
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	setDescription(String description)
void	setInheritanceConversions(Map<JIPipeDataInfo,JIPipeDataInfo> inheritanceConversions)
void	setInheritanceConversionsFromRaw(Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> inheritanceConversions)
void	setOptional(boolean optional)
void	setRole(JIPipeDataSlotRole role)
void	setSaveOutputs(boolean saveOutputs)
void	setUserModifiable(boolean userModifiable) Set this variable to make a slot not removable/editable.
void	setVirtual(boolean virtual)
JIPipeInputSlot	toInputSlotAnnotation() Converts this info into the annotation form.
JIPipeOutputSlot	toOutputSlotAnnotation() Converts this info into the annotation form.

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

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

JIPipeDataSlotInfo

protected JIPipeDataSlotInfo()

JIPipeDataSlotInfo

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

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

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

JIPipeDataSlotInfo

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

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)

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(JIPipeInputSlot slot)

Parameters:

slot - Imported annotation

JIPipeDataSlotInfo

public JIPipeDataSlotInfo(JIPipeOutputSlot slot)

Parameters:

slot - Imported annotation

JIPipeDataSlotInfo

public JIPipeDataSlotInfo(JIPipeDataSlotInfo other)

Copies the definition

Parameters:

other - The original

Method Detail

applyInheritanceConversion

public static Class<? extends JIPipeData> applyInheritanceConversion(JIPipeDataSlotInfo definition,
                                                                     Class<? extends JIPipeData> dataClass)

Applies inheritance conversion. This is a text replacement system with termination condition of never visiting the same time twice.

Parameters:

definition - The slot definition

dataClass - The slot data

Returns:

The converted data

composeRawInheritanceConversions

public static Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> composeRawInheritanceConversions(Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> outer,
                                                                                                            Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> inner)

Creates the composition of two inheritance conversions. The result is outer(inner(x))

Parameters:

outer - the outer conversion

inner - the inner conversion

Returns:

Inheritance conversion that is outer(inner(x))

composeInheritanceConversions

public static Map<JIPipeDataInfo,JIPipeDataInfo> composeInheritanceConversions(Map<JIPipeDataInfo,JIPipeDataInfo> outer,
                                                                               Map<JIPipeDataInfo,JIPipeDataInfo> inner)

Creates the composition of two inheritance conversions. The result is outer(inner(x))

Parameters:

outer - the outer conversion

inner - the inner conversion

Returns:

Inheritance conversion that is outer(inner(x))

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 JIPipeInputSlot toInputSlotAnnotation()

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

Returns:

the annotation

toOutputSlotAnnotation

public JIPipeOutputSlot 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()

getSlotType

public JIPipeSlotType getSlotType()

getName

public String getName()

getInheritedSlot

public String getInheritedSlot()

Gets slot to inherit the data type from If null or empty, this slot does not inherit If it equals '*', the first available input slot is chosen

Returns:

the slot name or '*' to pick the first slot or null

getInheritanceConversions

public Map<JIPipeDataInfo,JIPipeDataInfo> getInheritanceConversions()

setInheritanceConversions

public void setInheritanceConversions(Map<JIPipeDataInfo,JIPipeDataInfo> inheritanceConversions)

setInheritanceConversionsFromRaw

public void setInheritanceConversionsFromRaw(Map<Class<? extends JIPipeData>,Class<? extends JIPipeData>> inheritanceConversions)

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)

isSaveOutputs

public boolean isSaveOutputs()

setSaveOutputs

public void setSaveOutputs(boolean saveOutputs)

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

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeParameterCollection

Gets the event bus that posts events about the parameters

Specified by:

getEventBus in interface JIPipeParameterCollection

Returns:

The event bus triggering JIPipeParameterCollection.ParameterChangedEvent and JIPipeParameterCollection.ParameterStructureChangedEvent

getRole

public JIPipeDataSlotRole getRole()

setRole

public void setRole(JIPipeDataSlotRole role)