org.hkijena.jipipe.api.parameters

Class JIPipeDynamicParameterCollection

java.lang.Object

org.hkijena.jipipe.api.parameters.JIPipeDynamicParameterCollection

All Implemented Interfaces:

JIPipeCustomParameterCollection, JIPipeCustomTextDescriptionParameter, JIPipeParameterCollection, JIPipeValidatable, JsonDeserializable

Direct Known Subclasses:

GeneratedParameters, JIPipeCustomExpressionVariablesParameter, JIPipeDefaultCacheDisplayApplicationSettings, JIPipeDefaultResultImporterApplicationSettings, SlotMapParameterCollection

public class JIPipeDynamicParameterCollection
extends Object
implements JIPipeCustomParameterCollection, JIPipeValidatable, JsonDeserializable, JIPipeCustomTextDescriptionParameter

Holds a user-definable set of parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDynamicParameterCollection.BeforeAddParameterEvent
static class	JIPipeDynamicParameterCollection.BeforeAddParameterEventEmitter
static interface	JIPipeDynamicParameterCollection.BeforeAddParameterEventListener
static class	JIPipeDynamicParameterCollection.Deserializer
static class	JIPipeDynamicParameterCollection.UserParameterDefinition Parameter definition by a user

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

Constructor and Description
JIPipeDynamicParameterCollection()
JIPipeDynamicParameterCollection(boolean allowUserModification) Creates a new instance.
JIPipeDynamicParameterCollection(boolean allowUserModification, Class<?>[] allowedTypes) Creates a new instance
JIPipeDynamicParameterCollection(boolean allowUserModification, Set<JIPipeParameterTypeInfo> allowedTypes) Creates a new instance
JIPipeDynamicParameterCollection(JIPipeDynamicParameterCollection other) Copies the parameters from the original

Method Summary

Modifier and Type	Method and Description
JIPipeMutableParameterAccess	addParameter(JIPipeMutableParameterAccess parameterAccess) Adds a new parameter.
JIPipeMutableParameterAccess	addParameter(String key, Class<?> fieldClass) Adds a new parameter
JIPipeMutableParameterAccess	addParameter(String key, Class<?> fieldClass, String name, String description, Annotation... annotations)
void	beginModificationBlock() Halts all JIPipeParameterCollection.ParameterStructureChangedEvent until endModificationBlock() is called.
void	clear() Removes all parameters
boolean	containsKey(String key) Returns true if there is a parameter with given key
void	copyTo(JIPipeDynamicParameterCollection target) Copies the parameter configuration into the target
void	endModificationBlock() Ends a modification block started by beginModificationBlock().
void	fromJson(com.fasterxml.jackson.databind.JsonNode node) Loads the holder from JSON
JIPipeParameterAccess	get(String key) Returns the parameter with key
Set<Class<?>>	getAllowedTypes()
JIPipeDynamicParameterCollection.BeforeAddParameterEventEmitter	getBeforeAddParameterEventEmitter()
Function<JIPipeDynamicParameterCollection.UserParameterDefinition,JIPipeMutableParameterAccess>	getInstanceGenerator()
JIPipeMutableParameterAccess	getParameter(String key) Gets a parameter by its key
JIPipeParameterCollection.ParameterChangedEventEmitter	getParameterChangedEventEmitter() Emitter for changes in the parameter
Map<String,JIPipeParameterAccess>	getParameters() Returns all parameters Please note that those parameters must be sourced in this collection.
JIPipeParameterCollection.ParameterStructureChangedEventEmitter	getParameterStructureChangedEventEmitter() Emitter for changes in the structure of parameters
JIPipeParameterCollection.ParameterUIChangedEventEmitter	getParameterUIChangedEventEmitter() Emitter for changes in the parameter user interface
String	getTextDescription() Gets the parameter as custom text description
<T> T	getValue(String key, Class<T> klass) Gets a parameter value
boolean	isAllowUserModification()
void	removeParameter(String key) Removes a parameter
void	reportValidity(JIPipeValidationReportContext reportContext, JIPipeValidationReport report) Generates a validity report
void	setAllowedTypes(Set<Class<?>> allowedTypes) Sets allowed parameter types
void	setAllowUserModification(boolean allowUserModification) Enabled/disables if modification by users is allowed
void	setInstanceGenerator(Function<JIPipeDynamicParameterCollection.UserParameterDefinition,JIPipeMutableParameterAccess> instanceGenerator)
<T> boolean	setValue(String key, T value) Sets a parameter value
boolean	supportsAllParameterTypes()

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.parameters.JIPipeCustomParameterCollection

getChildParameterCollections, getIncludeReflectionParameters

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

Methods inherited from interface org.hkijena.jipipe.api.validation.JIPipeValidatable

generateValidityReport

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeCustomTextDescriptionParameter

getTextDescriptionOf

Constructor Detail

JIPipeDynamicParameterCollection

public JIPipeDynamicParameterCollection()

JIPipeDynamicParameterCollection

public JIPipeDynamicParameterCollection(boolean allowUserModification)

Creates a new instance. Automatically adds all known registered parameter types

Parameters:

allowUserModification - let user modify this collection

JIPipeDynamicParameterCollection

public JIPipeDynamicParameterCollection(JIPipeDynamicParameterCollection other)

Copies the parameters from the original

Parameters:

other - The original

JIPipeDynamicParameterCollection

public JIPipeDynamicParameterCollection(boolean allowUserModification,
                                        Set<JIPipeParameterTypeInfo> allowedTypes)

Creates a new instance

Parameters:

allowUserModification - let user modify this collection

allowedTypes - The parameter types that can be added by the user (ignored if user cannot add).

JIPipeDynamicParameterCollection

public JIPipeDynamicParameterCollection(boolean allowUserModification,
                                        Class<?>[] allowedTypes)

Creates a new instance

Parameters:

allowUserModification - let user modify this collection

allowedTypes - The parameter types that can be added by the user (ignored if user cannot add).

Method Detail

getBeforeAddParameterEventEmitter

public JIPipeDynamicParameterCollection.BeforeAddParameterEventEmitter getBeforeAddParameterEventEmitter()

getParameterChangedEventEmitter

public JIPipeParameterCollection.ParameterChangedEventEmitter getParameterChangedEventEmitter()

Description copied from interface: JIPipeParameterCollection

Emitter for changes in the parameter

Specified by:

getParameterChangedEventEmitter in interface JIPipeParameterCollection

Returns:

the emitter

getParameterStructureChangedEventEmitter

public JIPipeParameterCollection.ParameterStructureChangedEventEmitter getParameterStructureChangedEventEmitter()

Description copied from interface: JIPipeParameterCollection

Emitter for changes in the structure of parameters

Specified by:

getParameterStructureChangedEventEmitter in interface JIPipeParameterCollection

Returns:

the emitter

getParameterUIChangedEventEmitter

public JIPipeParameterCollection.ParameterUIChangedEventEmitter getParameterUIChangedEventEmitter()

Description copied from interface: JIPipeParameterCollection

Emitter for changes in the parameter user interface

Specified by:

getParameterUIChangedEventEmitter in interface JIPipeParameterCollection

Returns:

the emitter

getParameters

public Map<String,JIPipeParameterAccess> getParameters()

Description copied from interface: JIPipeCustomParameterCollection

Returns all parameters Please note that those parameters must be sourced in this collection. Use getChildParameterCollections() to add those

Specified by:

getParameters in interface JIPipeCustomParameterCollection

Returns:

Map from parameter ID to its access. The ID is not necessarily equal to JIPipeParameterAccess.getKey()

addParameter

public JIPipeMutableParameterAccess addParameter(JIPipeMutableParameterAccess parameterAccess)

Adds a new parameter. The parameterHolder attribute is changed

Parameters:

parameterAccess - the parameter

Returns:

the parameter access or null if it was cancelled

supportsAllParameterTypes

public boolean supportsAllParameterTypes()

addParameter

public JIPipeMutableParameterAccess addParameter(String key,
                                                 Class<?> fieldClass)

Adds a new parameter

Parameters:

key - A unique key

fieldClass - The parameter class

Returns:

The created parameter access

clear

public void clear()

Removes all parameters

removeParameter

public void removeParameter(String key)

Removes a parameter

Parameters:

key - The parameter key

getParameter

public JIPipeMutableParameterAccess getParameter(String key)

Gets a parameter by its key

Parameters:

key - The parameter key

Returns:

The parameter access

getValue

public <T> T getValue(String key,
                      Class<T> klass)

Gets a parameter value

Type Parameters:

T - The parameter type

Parameters:

key - The parameter key

klass - The returned type

Returns:

The parameter value

setValue

public <T> boolean setValue(String key,
                            T value)

Sets a parameter value

Type Parameters:

T - The parameter type

Parameters:

key - The parameter key

value - The parameter value

Returns:

True if setting the value was successful

getAllowedTypes

public Set<Class<?>> getAllowedTypes()

Returns:

Allowed parameter types

setAllowedTypes

public void setAllowedTypes(Set<Class<?>> allowedTypes)

Sets allowed parameter types

Parameters:

allowedTypes - Parameter types

fromJson

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

Loads the holder from JSON

Specified by:

fromJson in interface JsonDeserializable

Parameters:

node - JSON data

isAllowUserModification

public boolean isAllowUserModification()

Returns:

True if modification by users is allowed

setAllowUserModification

public void setAllowUserModification(boolean allowUserModification)

Enabled/disables if modification by users is allowed

Parameters:

allowUserModification - True if modification is allowed

containsKey

public boolean containsKey(String key)

Returns true if there is a parameter with given key

Parameters:

key - the parameter key

Returns:

if there is a parameter with given key

get

public JIPipeParameterAccess get(String key)

Returns the parameter with key

Parameters:

key - the parameter key

Returns:

the parameter access

beginModificationBlock

public void beginModificationBlock()

Halts all JIPipeParameterCollection.ParameterStructureChangedEvent until endModificationBlock() is called. Use this method for many changes at once

endModificationBlock

public void endModificationBlock()

Ends a modification block started by beginModificationBlock(). Triggers a JIPipeParameterCollection.ParameterStructureChangedEvent

copyTo

public void copyTo(JIPipeDynamicParameterCollection target)

Copies the parameter configuration into the target

Parameters:

target - the target configuration

reportValidity

public void reportValidity(JIPipeValidationReportContext reportContext,
                           JIPipeValidationReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

reportContext - the report context

report - the report to be added to

getInstanceGenerator

public Function<JIPipeDynamicParameterCollection.UserParameterDefinition,JIPipeMutableParameterAccess> getInstanceGenerator()

setInstanceGenerator

public void setInstanceGenerator(Function<JIPipeDynamicParameterCollection.UserParameterDefinition,JIPipeMutableParameterAccess> instanceGenerator)

addParameter

public JIPipeMutableParameterAccess addParameter(String key,
                                                 Class<?> fieldClass,
                                                 String name,
                                                 String description,
                                                 Annotation... annotations)

getTextDescription

public String getTextDescription()

Description copied from interface: JIPipeCustomTextDescriptionParameter

Gets the parameter as custom text description

Specified by:

getTextDescription in interface JIPipeCustomTextDescriptionParameter

Returns:

the text description