org.hkijena.jipipe.api.data

Interface JIPipeDataImportOperation

All Superinterfaces:

JIPipeDataOperation

All Known Implementing Classes:

CopyContainingFolderDataImportOperation, JIPipeDataDisplayWrapperImportOperation, OpenContainingFolderDataImportOperation, OpenInNativeApplicationDataImportOperation

public interface JIPipeDataImportOperation
extends JIPipeDataOperation

An operation that is executed on showing existing data located in memory/cache The operations must be registered and will appear if the developer does not override the default importer row UI.

Method Summary

Modifier and Type	Method and Description
default boolean	canShow(JIPipeDataSlot slot, JIPipeDataTableMetadataRow row, Path rowStorageFolder) Checks if the import is possible
JIPipeData	show(JIPipeDataSlot slot, JIPipeDataTableMetadataRow row, String dataAnnotationName, Path rowStorageFolder, String compartmentName, String algorithmName, String displayName, JIPipeWorkbench workbench, JIPipeProgressInfo progressInfo) Imports the data and shows it

Methods inherited from interface org.hkijena.jipipe.api.data.JIPipeDataOperation

getDescription, getIcon, getId, getName, getOrder

Method Detail

canShow

default boolean canShow(JIPipeDataSlot slot,
                        JIPipeDataTableMetadataRow row,
                        Path rowStorageFolder)

Checks if the import is possible

Parameters:

slot - the slot that is associated to the data. please note that the slot does not contain any binary data. it allows you to access the algorithm and graph.

row - the row in the output table

rowStorageFolder - the folder the row is storing the data

Returns:

if the import is possible

show

JIPipeData show(JIPipeDataSlot slot,
                JIPipeDataTableMetadataRow row,
                String dataAnnotationName,
                Path rowStorageFolder,
                String compartmentName,
                String algorithmName,
                String displayName,
                JIPipeWorkbench workbench,
                JIPipeProgressInfo progressInfo)

Imports the data and shows it

Parameters:

slot - the slot that is associated to the data. please note that the slot does not contain any binary data. it allows you to access the algorithm and graph.

row - the row in the output table

dataAnnotationName - Optional name of the data annotation that is referenced instead of the main data. Can be null, in which case the main data is referenced.

rowStorageFolder - the folder the row is storing the data. For data annotations, this is the row storage folder of the data annotation.

compartmentName - the name of the compartment that generated the data

algorithmName - the name of the algorithm that generated the data

displayName - a unique identifier for the slot

workbench - the workbench that issued the command

progressInfo - the JIPipeProgressInfo

Returns:

the imported data (optional). Can be null if no data is returned due to an error or delayed operation.