org.hkijena.jipipe.api.data

Interface JIPipeData

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

ColorImageData, FFTImageData, GreyscaleImageData, Image2DData, Image3DData, Image4DData, Image5DData, MutableTableColumn, TableColumn

All Known Implementing Classes:

AnnotationTableData, BarBoxAndWhiskerCategoryPlotData, BarCategoryPlotData, BarStatisticalCategoryPlotData, BooleanFormData, BorderImageJ2OutOfBoundsFactoryData, BoxAndWhiskerCategoryPlotData, ByteConstantValueImageJ2OutOfBoundsFactoryData, CategoryPlotData, CellposeModelData, CellposeSizeModelData, CenteredRectangleImageJ2ShapeData, CLIJImageData, DataBatchStatusData, DiamondImageJ2ShapeData, DiamondTipsImageJ2ShapeData, DoubleArrayTableColumn, DoubleConstantValueImageJ2OutOfBoundsFactoryData, DoubleFormData, EmptyImageJ2OutOfBoundsFactory, EmptyImageJ2ShapeData, EnumFormData, FileData, FloatArrayTableColumn, FloatConstantValueImageJ2OutOfBoundsFactoryData, FolderData, FormData, GroupHeaderFormData, HistogramPlotData, HorizontalLineImageJ2ShapeData, HyperSphereImageJ2ShapeData, ImageJ2DatasetData, ImageJ2OutOfBoundsFactoryData, ImageJ2ShapeData, ImagePlus2DColorData, ImagePlus2DColorHSBData, ImagePlus2DColorLABData, ImagePlus2DColorRGBData, ImagePlus2DData, ImagePlus2DGreyscale16UData, ImagePlus2DGreyscale32FData, ImagePlus2DGreyscale8UData, ImagePlus2DGreyscaleData, ImagePlus2DGreyscaleMaskData, ImagePlus3DColorData, ImagePlus3DColorHSBData, ImagePlus3DColorLABData, ImagePlus3DColorRGBData, ImagePlus3DData, ImagePlus3DGreyscale16UData, ImagePlus3DGreyscale32FData, ImagePlus3DGreyscale8UData, ImagePlus3DGreyscaleData, ImagePlus3DGreyscaleMaskData, ImagePlus4DColorData, ImagePlus4DColorHSBData, ImagePlus4DColorLABData, ImagePlus4DColorRGBData, ImagePlus4DData, ImagePlus4DGreyscale16UData, ImagePlus4DGreyscale32FData, ImagePlus4DGreyscale8UData, ImagePlus4DGreyscaleData, ImagePlus4DGreyscaleMaskData, ImagePlus5DColorData, ImagePlus5DColorHSBData, ImagePlus5DColorLABData, ImagePlus5DColorRGBData, ImagePlus5DData, ImagePlus5DGreyscale16UData, ImagePlus5DGreyscale32FData, ImagePlus5DGreyscale8UData, ImagePlus5DGreyscaleData, ImagePlus5DGreyscaleMaskData, ImagePlusColorData, ImagePlusColorHSBData, ImagePlusColorLABData, ImagePlusColorRGBData, ImagePlusData, ImagePlusFFT2DData, ImagePlusFFT3DData, ImagePlusFFT4DData, ImagePlusFFT5DData, ImagePlusFFTData, ImagePlusGreyscale16UData, ImagePlusGreyscale32FData, ImagePlusGreyscale8UData, ImagePlusGreyscaleData, ImagePlusGreyscaleMaskData, IntegerConstantValueImageJ2OutOfBoundsFactoryData, IntegerFormData, JIPipeCompartmentOutputData, JIPipeDataSlot, JIPipeDataTable, JIPipeEmptyData, JIPipeInputDataSlot, JIPipeOutputData, JIPipeOutputDataSlot, JIPipeSerializedJsonObjectData, JIPipeSerializedParameterCollectionData, JsonData, LineCategoryPlotData, LineStatisticalCategoryPlotData, LineXYPlotData, LongConstantValueImageJ2OutOfBoundsFactoryData, LUTData, MaskDrawerFormData, MirrorImageJ2OutOfBoundsFactoryData, ModelData, OMEImageData, OMERODatasetReferenceData, OMEROGroupReferenceData, OMEROImageReferenceData, OMEROProjectReferenceData, PairOfPointsImageJ2ShapeData, ParameterFormData, ParametersData, PathData, PathFormData, PeriodicImageJ2OutOfBoundsFactoryData, PeriodicLineImageJ2ShapeData, Pie2DPlotData, Pie3DPlotData, PiePlotData, PlotData, PlotDataSeries, RectangleImageJ2ShapeData, RelabeledTableColumn, ResultsTableData, ROIDrawerFormData, ROIListData, RowIndexTableColumn, ScatterXYPlotData, ShortConstantValueImageJ2OutOfBoundsFactoryData, SpotDetectorData, SpotsCollectionData, SpotTrackerData, StackedBarCategoryPlotData, StatisticalCategoryPlotData, StringArrayTableColumn, StringData, StringFormData, TableColumnReference, TrackCollectionData, WekaModelData, XMLData, XYPlotData, ZeroTableColumn

public interface JIPipeData
extends Closeable, AutoCloseable

Base class for any JIPipe data wrapper class There must be a static function importData(JIPipeReadDataStorage, JIPipeProgressInfo) that imports the data from a row storage folder. Additionally, there must be an annotation of type JIPipeDataStorageDocumentation that describes the structure of a valid row storage folder for humans. The static importData(@link org.hkijena.jipipe.api.data.storage.JIPipeReadDataStorage}, JIPipeProgressInfo) method and the JIPipeDataStorageDocumentation annotation can be omitted for abstract data types or interfaces. JIPipeDataStorageDocumentation can be inherited from parent classes.

Update: 1.74.0: The class is now closable, which is useful for handling external resources. JIPipeDataTable and JIPipeVirtualData were adapted to handle the close() automatically.

Method Summary

Modifier and Type	Method and Description
default void	close()
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
default void	exportThumbnails(JIPipeWriteDataStorage storage, Path target, List<Dimension> sizes, JIPipeProgressInfo progressInfo) Exports the thumbnails/previews of this data into the provided storage
static String	getDescriptionOf(Class<? extends JIPipeData> klass) Returns the description of a data type
static String	getMenuPathOf(Class<? extends JIPipeData> klass) Returns the menu path of the data type
static String	getNameOf(Class<? extends JIPipeData> klass) Returns the name of a data type
static List<Class<? extends JIPipeData>>	getSortedList(Collection<Class<? extends JIPipeData>> classes) Gets name sorted list of data classes
static HTMLText	getStorageDocumentation(Class<? extends JIPipeData> klass) Returns the storage documentation for the data type or null if none was provided.
static String	getStorageSchema(Class<? extends JIPipeData> klass) Returns the URL pointing to a JSON schema that describes the storage of the data type.
static Map<String,Set<Class<? extends JIPipeData>>>	groupByMenuPath(Collection<Class<? extends JIPipeData>> classes) Groups the data types by their menu path
static boolean	isCommon(Class<? extends JIPipeData> klass) Returns true if this data is commonly used (only for UI)
static boolean	isHeavy(Class<? extends JIPipeData> klass) Returns true if this data is considered as having a large size
static boolean	isHidden(Class<? extends JIPipeData> klass) Returns true if this data should be be accessible by the user
default Component	preview(int width, int height) This function generates a preview component for usage within the GUI Can return null
default String	toDetailedString() This method returns a detailed string description (with multi-line, etc.) of the data.

Method Detail

getNameOf

static String getNameOf(Class<? extends JIPipeData> klass)

Returns the name of a data type

Parameters:

klass - The data class

Returns:

The name of the data class

getDescriptionOf

static String getDescriptionOf(Class<? extends JIPipeData> klass)

Returns the description of a data type

Parameters:

klass - The data class

Returns:

The data class description

getMenuPathOf

static String getMenuPathOf(Class<? extends JIPipeData> klass)

Returns the menu path of the data type

Parameters:

klass - The data class

Returns:

The menu path of the data class

isHidden

static boolean isHidden(Class<? extends JIPipeData> klass)

Returns true if this data should be be accessible by the user

Parameters:

klass - Data class

Returns:

If the data should be hidden from user

isHeavy

static boolean isHeavy(Class<? extends JIPipeData> klass)

Returns true if this data is considered as having a large size

Parameters:

klass - Data class

Returns:

If this data is considered as having a large size

isCommon

static boolean isCommon(Class<? extends JIPipeData> klass)

Returns true if this data is commonly used (only for UI)

Parameters:

klass - Data class

Returns:

If this data is commonly used

getStorageDocumentation

static HTMLText getStorageDocumentation(Class<? extends JIPipeData> klass)

Returns the storage documentation for the data type or null if none was provided. Will go through parent classes to find a storage documentation

Parameters:

klass - the class

Returns:

the storage documentation

getStorageSchema

static String getStorageSchema(Class<? extends JIPipeData> klass)

Returns the URL pointing to a JSON schema that describes the storage of the data type. Will return null if none was provided. Will go through parent classes to find a storage documentation

Parameters:

klass - the class

Returns:

the storage documentation

getSortedList

static List<Class<? extends JIPipeData>> getSortedList(Collection<Class<? extends JIPipeData>> classes)

Gets name sorted list of data classes

Parameters:

classes - The data classes

Returns:

A name-sorted list of data classes

groupByMenuPath

static Map<String,Set<Class<? extends JIPipeData>>> groupByMenuPath(Collection<Class<? extends JIPipeData>> classes)

Groups the data types by their menu path

Parameters:

classes - The data classes

Returns:

Map from menu path to a set of data classes that have the menu path

exportData

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

Saves the data to a folder

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

JIPipeData duplicate(JIPipeProgressInfo progressInfo)

Duplicates the data

Parameters:

progressInfo - the progress of duplicating the data

Returns:

a deep copy of the data

display

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

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.

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)

preview

default Component preview(int width,
                          int height)

This function generates a preview component for usage within the GUI Can return null

Parameters:

width - the target width

height - the target height

Returns:

the component or null if none should be available

toDetailedString

default String toDetailedString()

This method returns a detailed string description (with multi-line, etc.) of the data. It can be used if toString() would yield too much information. Defaults to toString()

Returns:

detailed description string

close

default void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

exportThumbnails

default void exportThumbnails(JIPipeWriteDataStorage storage,
                              Path target,
                              List<Dimension> sizes,
                              JIPipeProgressInfo progressInfo)

Exports the thumbnails/previews of this data into the provided storage

Parameters:

storage - the storage

target - the location of the data (as internal path within the data table) that is described by the thumbnails

sizes - the sizes to save (in pixels)

progressInfo - the progress info