org.hkijena.jipipe.api.parameters

Class DefaultJIPipeParameterGenerator

java.lang.Object

org.hkijena.jipipe.api.parameters.DefaultJIPipeParameterGenerator

All Implemented Interfaces:

JIPipeValidatable, JIPipeParameterCollection, JIPipeParameterGenerator

Direct Known Subclasses:

EnumParameterGenerator, NumberRangeParameterGenerator

public abstract class DefaultJIPipeParameterGenerator
extends Object
implements JIPipeParameterGenerator, JIPipeParameterCollection, JIPipeValidatable

A default implementation of JIPipeParameterGenerator that shows all parameters of this JIPipeParameterCollection in a dialog before generating the data. The dialog input is checked by the validation function.

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
DefaultJIPipeParameterGenerator()

Method Summary

Modifier and Type	Method and Description
<T> List<T>	generate(JIPipeWorkbench workbench, Component parent, Class<T> klass) Generates the values
abstract <T> List<T>	generateAfterDialog(JIPipeWorkbench workbench, Component parent, Class<T> klass) This function generates the values after the dialog was confirmed
EventBus	getEventBus() Gets the event bus that posts events about the parameters
void	reportValidity(JIPipeIssueReport report) Generates a validity report

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.JIPipeParameterGenerator

getDescription, getName

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

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

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

generateValidityReport

Constructor Detail

DefaultJIPipeParameterGenerator

public DefaultJIPipeParameterGenerator()

Method Detail

generate

public <T> List<T> generate(JIPipeWorkbench workbench,
                            Component parent,
                            Class<T> klass)

Description copied from interface: JIPipeParameterGenerator

Generates the values

Specified by:

generate in interface JIPipeParameterGenerator

Type Parameters:

T - the generated field type

Parameters:

workbench - the workbench

parent - the parent component for any dialogs

klass - the generated field class

Returns:

the generated values

reportValidity

public void reportValidity(JIPipeIssueReport report)

Description copied from interface: JIPipeValidatable

Generates a validity report

Specified by:

reportValidity in interface JIPipeValidatable

Parameters:

report - the report to be added to

generateAfterDialog

public abstract <T> List<T> generateAfterDialog(JIPipeWorkbench workbench,
                                                Component parent,
                                                Class<T> klass)

This function generates the values after the dialog was confirmed

Type Parameters:

T - the generated class

Parameters:

parent - the parent

Returns:

the list of generated objects

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