org.hkijena.jipipe.api.data

Class JIPipeDefaultMutableSlotConfiguration

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeDefaultMutableSlotConfiguration

All Implemented Interfaces:

JIPipeMutableSlotConfiguration, JIPipeSlotConfiguration

Direct Known Subclasses:

JIPipeIOSlotConfiguration

public class JIPipeDefaultMutableSlotConfiguration
extends Object
implements JIPipeMutableSlotConfiguration

A schema for slots

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDefaultMutableSlotConfiguration.Builder A builder for creating a configuration

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.data.JIPipeSlotConfiguration

JIPipeSlotConfiguration.Serializer, JIPipeSlotConfiguration.SlotsChangedEvent

Constructor Summary

Constructors

Constructor and Description
JIPipeDefaultMutableSlotConfiguration() Creates a new instance

Method Summary

Modifier and Type	Method and Description
JIPipeDataSlotInfo	addInputSlot(String name, String description, Class<? extends JIPipeData> dataClass, boolean user) Adds a new input slot
JIPipeDataSlotInfo	addOutputSlot(String name, String description, Class<? extends JIPipeData> dataClass, String inherited, boolean user) Adds a new input slot
JIPipeDataSlotInfo	addSlot(JIPipeInputSlot slot, boolean user) Adds an input slot from an annotation
JIPipeDataSlotInfo	addSlot(JIPipeOutputSlot slot, boolean user) Adds an input slot from an annotation
JIPipeDataSlotInfo	addSlot(String name, JIPipeDataSlotInfo definition, boolean user) Adds a slots
boolean	allowsInputSlots()
boolean	allowsOutputSlots()
static JIPipeDefaultMutableSlotConfiguration.Builder	builder()
boolean	canAddInputSlot()
boolean	canAddOutputSlot()
boolean	canCreateCompatibleInputSlot(Class<? extends JIPipeData> acceptedDataType) Returns if an input slot with specified type can be created
boolean	canCreateCompatibleOutputSlot(Class<? extends JIPipeData> acceptedDataType) Returns if an output slot with specified type can be created
boolean	canModifyInputSlots()
boolean	canModifyOutputSlots()
void	clearInputSlots(boolean user) Removes all input slots
void	clearOutputSlots(boolean user) Removes all output slots
JIPipeSlotConfiguration	duplicate() Creates a deep copy
void	fromJson(com.fasterxml.jackson.databind.JsonNode node) Loads this configuration from JSON
Set<Class<? extends JIPipeData>>	getAllowedInputSlotTypes()
Set<Class<? extends JIPipeData>>	getAllowedOutputSlotTypes()
EventBus	getEventBus()
List<String>	getInputSlotOrder()
Map<String,JIPipeDataSlotInfo>	getInputSlots()
int	getMaxInputSlots()
int	getMaxOutputSlots()
List<String>	getOutputSlotOrder()
Map<String,JIPipeDataSlotInfo>	getOutputSlots()
static Set<Class<? extends JIPipeData>>	getUnhiddenRegisteredDataTypes() Returns a collection of all unhidden slot data types
boolean	hasInputSlot(String name) Returns true if there is an input slot with name
boolean	hasOutputSlot(String name) Returns true if there is an output slot with name
boolean	isAllowInheritedOutputSlots()
boolean	isInputSlotsSealed()
boolean	isOutputSlotsSealed()
void	moveDown(String slot, JIPipeSlotType type) Moves the specified slot down in its order
void	moveUp(String slot, JIPipeSlotType type) Moves the specified slot up in its order
void	removeInputSlot(String name, boolean user) Removes the slot with given name
void	removeOutputSlot(String name, boolean user) Removes the slot with given name
void	setAllowedInputSlotTypes(Set<Class<? extends JIPipeData>> allowedInputSlotTypes)
void	setAllowedOutputSlotTypes(Set<Class<? extends JIPipeData>> allowedOutputSlotTypes)
void	setAllowInheritedOutputSlots(boolean allowInheritedOutputSlots) Enables/Disables if output slots can inherit from input slots
void	setInputSealed(boolean b) Seals/Unseals input slots
void	setMaxInputSlots(int maxInputSlots) Sets maximum number of input slots
void	setMaxOutputSlots(int maxOutputSlots) Sets maximum number of output slots
void	setOutputSealed(boolean b) Seals/Unseals output slots
void	setTo(JIPipeSlotConfiguration configuration) Makes this slot configuration equivalent to the provided one
void	toJson(com.fasterxml.jackson.core.JsonGenerator jsonGenerator) Saves this configuration to JSON.
void	trySetInputSlotOrder(List<String> newOrder) Sets the input slot order.
void	trySetOutputSlotOrder(List<String> newOrder) Sets the output slot order.

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.data.JIPipeMutableSlotConfiguration

addSlot, canRemoveInputSlot, canRemoveOutputSlot

Constructor Detail

JIPipeDefaultMutableSlotConfiguration

public JIPipeDefaultMutableSlotConfiguration()

Creates a new instance

Method Detail

getUnhiddenRegisteredDataTypes

public static Set<Class<? extends JIPipeData>> getUnhiddenRegisteredDataTypes()

Returns a collection of all unhidden slot data types

Returns:

the collection

builder

public static JIPipeDefaultMutableSlotConfiguration.Builder builder()

Returns:

A builder for creating a configuration

hasInputSlot

public boolean hasInputSlot(String name)

Returns true if there is an input slot with name

Specified by:

hasInputSlot in interface JIPipeSlotConfiguration

Parameters:

name - The name

Returns:

True if a slot with the name exists

hasOutputSlot

public boolean hasOutputSlot(String name)

Returns true if there is an output slot with name

Specified by:

hasOutputSlot in interface JIPipeSlotConfiguration

Parameters:

name - The name

Returns:

True if a slot with the name exists

addSlot

public JIPipeDataSlotInfo addSlot(String name,
                                  JIPipeDataSlotInfo definition,
                                  boolean user)

Adds a slots

Specified by:

addSlot in interface JIPipeMutableSlotConfiguration

Parameters:

name - Unique slot name

definition - Defines the slot

user - if the change was triggered by a user. If false, checks for slot sealing, types, etc. do not apply

Returns:

the slot definition of the added slot

toJson

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

Description copied from interface: JIPipeSlotConfiguration

Saves this configuration to JSON.

Specified by:

toJson in interface JIPipeSlotConfiguration

Parameters:

jsonGenerator - the Json generator

Throws:

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

IOException

removeInputSlot

public void removeInputSlot(String name,
                            boolean user)

Removes the slot with given name

Specified by:

removeInputSlot in interface JIPipeMutableSlotConfiguration

Parameters:

name - Slot name

user - if the change was triggered by a user. If false, checks for slot modification, counts, etc. do not apply.

addSlot

public JIPipeDataSlotInfo addSlot(JIPipeInputSlot slot,
                                  boolean user)

Adds an input slot from an annotation

Parameters:

slot - the slot annotation

user - if the change was triggered by a user. If false, checks for slot modification, counts, etc. do not apply.

Returns:

the slot info

addSlot

public JIPipeDataSlotInfo addSlot(JIPipeOutputSlot slot,
                                  boolean user)

Adds an input slot from an annotation

Parameters:

slot - the slot annotation

user - if the change was triggered by a user. If false, checks for slot modification, counts, etc. do not apply.

Returns:

the slot info

addInputSlot

public JIPipeDataSlotInfo addInputSlot(String name,
                                       String description,
                                       Class<? extends JIPipeData> dataClass,
                                       boolean user)

Adds a new input slot

Parameters:

name - the name

description - the description

dataClass - the data type

user - if the user triggered this

Returns:

the slot info

addOutputSlot

public JIPipeDataSlotInfo addOutputSlot(String name,
                                        String description,
                                        Class<? extends JIPipeData> dataClass,
                                        String inherited,
                                        boolean user)

Adds a new input slot

Parameters:

name - the name

description - the description

dataClass - the data type

inherited - inherited slot can be null or '*' or the slot name

user - if the user triggered this

Returns:

the slot info

removeOutputSlot

public void removeOutputSlot(String name,
                             boolean user)

Removes the slot with given name

Specified by:

removeOutputSlot in interface JIPipeMutableSlotConfiguration

Parameters:

name - Slot name

user - if the change was triggered by a user. If false, checks for slot modification, counts, etc. do not apply.

getInputSlots

public Map<String,JIPipeDataSlotInfo> getInputSlots()

Specified by:

getInputSlots in interface JIPipeSlotConfiguration

Returns:

the input slots

getOutputSlots

public Map<String,JIPipeDataSlotInfo> getOutputSlots()

Specified by:

getOutputSlots in interface JIPipeSlotConfiguration

Returns:

the output slots

duplicate

public JIPipeSlotConfiguration duplicate()

Description copied from interface: JIPipeSlotConfiguration

Creates a deep copy

Specified by:

duplicate in interface JIPipeSlotConfiguration

Returns:

a deep copy

getInputSlotOrder

public List<String> getInputSlotOrder()

Specified by:

getInputSlotOrder in interface JIPipeSlotConfiguration

Returns:

the input slot order

getOutputSlotOrder

public List<String> getOutputSlotOrder()

Specified by:

getOutputSlotOrder in interface JIPipeSlotConfiguration

Returns:

the output slot order

setTo

public void setTo(JIPipeSlotConfiguration configuration)

Description copied from interface: JIPipeSlotConfiguration

Makes this slot configuration equivalent to the provided one

Specified by:

setTo in interface JIPipeSlotConfiguration

Parameters:

configuration - the configuration

fromJson

public void fromJson(com.fasterxml.jackson.databind.JsonNode node)

Description copied from interface: JIPipeSlotConfiguration

Loads this configuration from JSON

Specified by:

fromJson in interface JIPipeSlotConfiguration

Parameters:

node - JSON data

moveUp

public void moveUp(String slot,
                   JIPipeSlotType type)

Moves the specified slot up in its order

Specified by:

moveUp in interface JIPipeMutableSlotConfiguration

Parameters:

slot - Slot name

type - the slot type

moveDown

public void moveDown(String slot,
                     JIPipeSlotType type)

Moves the specified slot down in its order

Specified by:

moveDown in interface JIPipeMutableSlotConfiguration

Parameters:

slot - Slot name

type - the slot type

trySetInputSlotOrder

public void trySetInputSlotOrder(List<String> newOrder)

Sets the input slot order. Automatically ignores missing or invalid slots. Undefined slots are put at the end of the order.

Parameters:

newOrder - the order

trySetOutputSlotOrder

public void trySetOutputSlotOrder(List<String> newOrder)

Sets the output slot order. Automatically ignores missing or invalid slots. Undefined slots are put at the end of the order.

Parameters:

newOrder - the order

allowsInputSlots

public boolean allowsInputSlots()

Specified by:

allowsInputSlots in interface JIPipeMutableSlotConfiguration

Returns:

If the configuration allows input slots

allowsOutputSlots

public boolean allowsOutputSlots()

Specified by:

allowsOutputSlots in interface JIPipeMutableSlotConfiguration

Returns:

If the configuration allows output slots

isInputSlotsSealed

public boolean isInputSlotsSealed()

Specified by:

isInputSlotsSealed in interface JIPipeMutableSlotConfiguration

Returns:

If input slots are unmodifiable

isOutputSlotsSealed

public boolean isOutputSlotsSealed()

Specified by:

isOutputSlotsSealed in interface JIPipeMutableSlotConfiguration

Returns:

If output slots are unmodifiable

canModifyInputSlots

public boolean canModifyInputSlots()

Specified by:

canModifyInputSlots in interface JIPipeMutableSlotConfiguration

Returns:

If input slots can be modified

canModifyOutputSlots

public boolean canModifyOutputSlots()

Specified by:

canModifyOutputSlots in interface JIPipeMutableSlotConfiguration

Returns:

If output slots can be modified

getAllowedInputSlotTypes

public Set<Class<? extends JIPipeData>> getAllowedInputSlotTypes()

Specified by:

getAllowedInputSlotTypes in interface JIPipeMutableSlotConfiguration

Returns:

Allowed input slot types.

setAllowedInputSlotTypes

public void setAllowedInputSlotTypes(Set<Class<? extends JIPipeData>> allowedInputSlotTypes)

getAllowedOutputSlotTypes

public Set<Class<? extends JIPipeData>> getAllowedOutputSlotTypes()

Specified by:

getAllowedOutputSlotTypes in interface JIPipeMutableSlotConfiguration

Returns:

Allowed output slot types

setAllowedOutputSlotTypes

public void setAllowedOutputSlotTypes(Set<Class<? extends JIPipeData>> allowedOutputSlotTypes)

setInputSealed

public void setInputSealed(boolean b)

Seals/Unseals input slots

Parameters:

b - Seals/Unseals input slots

setOutputSealed

public void setOutputSealed(boolean b)

Seals/Unseals output slots

Parameters:

b - Seals/Unseals output slots

canCreateCompatibleInputSlot

public boolean canCreateCompatibleInputSlot(Class<? extends JIPipeData> acceptedDataType)

Returns if an input slot with specified type can be created

Specified by:

canCreateCompatibleInputSlot in interface JIPipeMutableSlotConfiguration

Parameters:

acceptedDataType - Slot data type

Returns:

True if it can be added

canCreateCompatibleOutputSlot

public boolean canCreateCompatibleOutputSlot(Class<? extends JIPipeData> acceptedDataType)

Returns if an output slot with specified type can be created

Specified by:

canCreateCompatibleOutputSlot in interface JIPipeMutableSlotConfiguration

Parameters:

acceptedDataType - Slot data type

Returns:

True if it can be added

getMaxInputSlots

public int getMaxInputSlots()

Returns:

Maximum number of input slots

setMaxInputSlots

public void setMaxInputSlots(int maxInputSlots)

Sets maximum number of input slots

Parameters:

maxInputSlots - Number

getMaxOutputSlots

public int getMaxOutputSlots()

Returns:

Maximum number of output slots

setMaxOutputSlots

public void setMaxOutputSlots(int maxOutputSlots)

Sets maximum number of output slots

Parameters:

maxOutputSlots - Number

canAddInputSlot

public boolean canAddInputSlot()

Specified by:

canAddInputSlot in interface JIPipeMutableSlotConfiguration

Returns:

If an input slot can be added

canAddOutputSlot

public boolean canAddOutputSlot()

Specified by:

canAddOutputSlot in interface JIPipeMutableSlotConfiguration

Returns:

If an output slot can be added

clearInputSlots

public void clearInputSlots(boolean user)

Removes all input slots

Parameters:

user - if done by a user

clearOutputSlots

public void clearOutputSlots(boolean user)

Removes all output slots

Parameters:

user - if done by a user

isAllowInheritedOutputSlots

public boolean isAllowInheritedOutputSlots()

Specified by:

isAllowInheritedOutputSlots in interface JIPipeMutableSlotConfiguration

Returns:

If output slots can inherit from input slots

setAllowInheritedOutputSlots

public void setAllowInheritedOutputSlots(boolean allowInheritedOutputSlots)

Enables/Disables if output slots can inherit from input slots

Parameters:

allowInheritedOutputSlots - Enables/Disables if output slots can inherit from input slots

getEventBus

public EventBus getEventBus()

Specified by:

getEventBus in interface JIPipeSlotConfiguration

Returns:

the event bus