org.hkijena.jipipe.api.data

Class JIPipeDataDisplayWrapperImportOperation

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeDataDisplayWrapperImportOperation

All Implemented Interfaces:

JIPipeDataImportOperation, JIPipeDataOperation

public class JIPipeDataDisplayWrapperImportOperation
extends Object
implements JIPipeDataImportOperation

A JIPipeDataImportOperation that wraps around a JIPipeDataDisplayOperation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeDataDisplayWrapperImportOperation.ImportDataRun

Constructor Summary

Constructors

Constructor and Description
JIPipeDataDisplayWrapperImportOperation(JIPipeDataDisplayOperation displayOperation)

Method Summary

Modifier and Type	Method and Description
String	getDescription()
JIPipeDataDisplayOperation	getDisplayOperation()
Icon	getIcon()
String	getId()
String	getName()
int	getOrder()
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

canShow

Constructor Detail

JIPipeDataDisplayWrapperImportOperation

public JIPipeDataDisplayWrapperImportOperation(JIPipeDataDisplayOperation displayOperation)

Method Detail

getDisplayOperation

public JIPipeDataDisplayOperation getDisplayOperation()

show

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

Description copied from interface: JIPipeDataImportOperation

Imports the data and shows it

Specified by:

show in interface JIPipeDataImportOperation

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.

getId

public String getId()

Specified by:

getId in interface JIPipeDataOperation

Returns:

Unique ID of this operation

getName

public String getName()

Specified by:

getName in interface JIPipeDataOperation

Returns:

The name of this operation

getDescription

public String getDescription()

Specified by:

getDescription in interface JIPipeDataOperation

Returns:

a description of the operation

getOrder

public int getOrder()

Specified by:

getOrder in interface JIPipeDataOperation

Returns:

the order in menu. lower values are sorted to the top. The first one is used as default if the user did not select one.

getIcon

public Icon getIcon()

Specified by:

getIcon in interface JIPipeDataOperation

Returns:

optional icon for the operation. can be null