org.hkijena.jipipe.api.parameters

Interface JIPipeCustomParameterCollection

All Superinterfaces:

JIPipeParameterCollection

All Known Implementing Classes:

GeneratedParameters, GraphNodeParameterReferenceAccessGroup, GraphNodeParameterReferenceAccessGroupList, InputSlotMapParameterCollection, JIPipeCustomExpressionVariablesParameter, JIPipeDefaultCacheDisplayApplicationSettings, JIPipeDefaultResultImporterApplicationSettings, JIPipeDesktopMergedProjectSettings, JIPipeDesktopMergedProjectSettingsUserDirectories, JIPipeDynamicParameterCollection, JIPipeNodeGroup, JIPipeParameterTree, JIPipeProjectCompartment, JIPipeProjectInfoParameters, JsonAlgorithm, OutputSlotMapParameterCollection, SlotMapParameterCollection

public interface JIPipeCustomParameterCollection
extends JIPipeParameterCollection

If a class inherits from this interface, reflection-based parameter discovery is replaced by the getCustomParameters() method result.

Nested Class Summary

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

Method Summary

Modifier and Type	Method and Description
default Map<String,JIPipeParameterCollection>	getChildParameterCollections() Returns all sub-parameter collections
default boolean	getIncludeReflectionParameters() If true, also include parameters discovered via reflection.
Map<String,JIPipeParameterAccess>	getParameters() Returns all parameters Please note that those parameters must be sourced in this collection.

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

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Method Detail

getParameters

Map<String,JIPipeParameterAccess> getParameters()

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

Returns:

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

getChildParameterCollections

default Map<String,JIPipeParameterCollection> getChildParameterCollections()

Returns all sub-parameter collections

Returns:

Map from unique collection ID to the collection.

getIncludeReflectionParameters

default boolean getIncludeReflectionParameters()

If true, also include parameters discovered via reflection. Custom parameters are added/override reflection parameters

Returns:

if parameters also should be discovered via reflection