org.hkijena.jipipe.api.data

Class JIPipeSerializedJsonObjectData

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeSerializedJsonObjectData

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData

Direct Known Subclasses:

DataBatchStatusData

public abstract class JIPipeSerializedJsonObjectData
extends Object
implements JIPipeData

A base class for JIPipeData that is serialized from/to JSON for convenience 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.

Constructor Summary

Constructors

Constructor and Description
JIPipeSerializedJsonObjectData()
JIPipeSerializedJsonObjectData(JIPipeSerializedJsonObjectData other)

Method Summary

Modifier and Type	Method and Description
JIPipeData	duplicate(JIPipeProgressInfo progressInfo) Duplicates the data
void	exportData(JIPipeWriteDataStorage storage, String name, boolean forceName, JIPipeProgressInfo progressInfo) Saves the data to a folder
static <T extends JIPipeData> T	importData(JIPipeReadDataStorage storage, Class<T> klass)

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, display, exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, preview, toDetailedString

Constructor Detail

JIPipeSerializedJsonObjectData

public JIPipeSerializedJsonObjectData()

JIPipeSerializedJsonObjectData

public JIPipeSerializedJsonObjectData(JIPipeSerializedJsonObjectData other)

Method Detail

importData

public static <T extends JIPipeData> T importData(JIPipeReadDataStorage storage,
                                                  Class<T> klass)

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

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