org.hkijena.jipipe.api.data

Class JIPipeSerializedParameterCollectionData

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeSerializedParameterCollectionData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData, JIPipeParameterCollection

Direct Known Subclasses:

ImageJ2OutOfBoundsFactoryData, ImageJ2ShapeData

public abstract class JIPipeSerializedParameterCollectionData
extends Object
implements JIPipeData, JIPipeParameterCollection

A base class for JIPipeData that is serialized from/to JSON for convenience Only valid JIPipeParameter definitions are stored. Ensure that this data type has a copy constructor for the duplicate() function. You also still need to add the proper JIPipeDocumentation annotation and the JIPipeData importData(Path) static function. Unlike JIPipeSerializedJsonObjectData, this data is serialized in a way to fully restore its data type during deserialization, removing the requirement of storing the data type ID within the JSON.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeSerializedParameterCollectionData.Deserializer
static class	JIPipeSerializedParameterCollectionData.Serializer

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
JIPipeSerializedParameterCollectionData()
JIPipeSerializedParameterCollectionData(JIPipeSerializedParameterCollectionData other)

Method Summary

Modifier and Type	Method and Description
void	display(String displayName, JIPipeWorkbench workbench, JIPipeDataSource source) This function should display the data in the GUI.
JIPipeData	duplicate(JIPipeProgressInfo progressInfo) Duplicates the data
void	exportData(JIPipeWriteDataStorage storage, String name, boolean forceName, JIPipeProgressInfo progressInfo) Saves the data to a folder
EventBus	getEventBus() Gets the event bus that posts events about the parameters
static JIPipeData	importData(JIPipeReadDataStorage storage, JIPipeProgressInfo progressInfo)

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

close, exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, preview, toDetailedString

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

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

Constructor Detail

JIPipeSerializedParameterCollectionData

public JIPipeSerializedParameterCollectionData()

JIPipeSerializedParameterCollectionData

public JIPipeSerializedParameterCollectionData(JIPipeSerializedParameterCollectionData other)

Method Detail

importData

public static JIPipeData importData(JIPipeReadDataStorage storage,
                                    JIPipeProgressInfo progressInfo)

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

exportData

public void exportData(JIPipeWriteDataStorage storage,
                       String name,
                       boolean forceName,
                       JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Saves the data to a folder

Specified by:

exportData in interface JIPipeData

Parameters:

storage - The storage where the data should be written

name - A name reference that can be used to generate filename(s)

forceName - If enabled, the data is saved potentially destructively. Generated files must always contain the name parameter. This is used to collect results for humans or other algorithms.

progressInfo - the progress

display

public void display(String displayName,
                    JIPipeWorkbench workbench,
                    JIPipeDataSource source)

Description copied from interface: JIPipeData

This function should display the data in the GUI. The UI can handle multiple of such operations via JIPipeDataDisplayOperation that can be registered separately. This item will always be shown as "Default" in the list of operations.

Specified by:

display in interface JIPipeData

Parameters:

displayName - a name that can be used

workbench - the workbench

source - optional source of the data. Can be null or any kind of data type (e.g. JIPipeDataSlot)

duplicate

public JIPipeData duplicate(JIPipeProgressInfo progressInfo)

Description copied from interface: JIPipeData

Duplicates the data

Specified by:

duplicate in interface JIPipeData

Parameters:

progressInfo - the progress of duplicating the data

Returns:

a deep copy of the data