org.hkijena.jipipe.api.data

Class JIPipeDataSlot

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeDataTable

org.hkijena.jipipe.api.data.JIPipeDataSlot

All Implemented Interfaces:

Closeable, AutoCloseable, TableModel, JIPipeData

Direct Known Subclasses:

JIPipeInputDataSlot, JIPipeOutputDataSlot

public abstract class JIPipeDataSlot
extends JIPipeDataTable

A data slot holds an JIPipeData instance. Slots are part of an JIPipeGraphNode

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCATION_KEY_NODE_DISPLAY_NAME To be used with getLocation().
static String	LOCATION_KEY_NODE_NAME To be used with getLocation().
static String	LOCATION_KEY_SLOT_DISPLAY_NAME To be used with getLocation().
static String	LOCATION_KEY_SLOT_IO To be used with getLocation().
static String	LOCATION_KEY_SLOT_NAME To be used with getLocation().

Constructor Summary

Constructors

Constructor and Description
JIPipeDataSlot(JIPipeDataSlot other, boolean shallow, JIPipeProgressInfo progressInfo)
JIPipeDataSlot(JIPipeDataSlotInfo info, JIPipeGraphNode node) Creates a new slot

Method Summary

Modifier and Type	Method and Description
void	applyVirtualState(JIPipeProgressInfo progressInfo) If virtual, put all data into the virtual storage If not, fetch all virtual data from storage This function reacts to the virtual mode setting in VirtualDataSettings and will refuse to make data virtual
static JIPipeInputDataSlot	createSingletonSlot(JIPipeData data, JIPipeGraphNode node) Creates a new input slot that contains only one data item
void	exportToSlotStoragePath(JIPipeProgressInfo saveProgress) Saves the data to the storage path Info: This method only works for output slots and saves to the storage path.
void	flush(JIPipeProgressInfo saveProgress) Saves the stored data to the provided storage path and sets data to null Warning: Ensure that depending input slots do not use this slot, anymore!
String	getDescription()
String	getDisplayName() Returns a name that includes the algorithm name and the slot name.
JIPipeDataSlotInfo	getInfo()
String	getLocation(String key, String defaultValue) Returns info about the location of this data table.
String	getName()
JIPipeGraphNode	getNode()
Path	getRowStoragePath(int index) Gets the storage path of a data row from a result.
Path	getSlotStoragePath() Gets the storage path that is used during running the algorithm for saving the results This is not used during project creation
JIPipeSlotType	getSlotType()
JIPipeDataTableMetadata	getStorageDataTable() Only valid for slots generated by a JIPipeProjectRun.
Path	getStorageDataTablePath() Only valid for slots generated by a JIPipeProjectRun.
boolean	isInput()
boolean	isOutput()
void	setNode(JIPipeGraphNode node) Reassigns the node
void	setSlotStoragePath(Path slotStoragePath) Sets storage path that is used during running the algorithm for saving the results
String	toString()

Methods inherited from class org.hkijena.jipipe.api.data.JIPipeDataTable

accepts, accepts, acceptsTrivially, acceptsTrivially, addAnnotationToAllData, addData, addData, addData, addData, addData, addData, addFromTable, addTableModelListener, addTextAnnotationToAllData, clear, clearData, convert, destroyData, display, duplicate, exportData, exportData, findRowWithAnnotations, fireChangedEvent, getAcceptedDataType, getAllData, getAllDataAnnotations, getAllTextAnnotations, getAnnotationColumns, getAnnotationMap, getColumnClass, getColumnCount, getColumnName, getData, getDataAnnotation, getDataAnnotationColumns, getDataAnnotations, getDataAnnotations, getDataClass, getEventBus, getLocation, getRowCount, getTextAnnotation, getTextAnnotation, getTextAnnotationColumns, getTextAnnotationMap, getTextAnnotationOr, getTextAnnotations, getTextAnnotations, getValueAt, getVirtualData, getVirtualDataAnnotation, getVirtualDataAnnotationMap, importData, isCellEditable, isEmpty, isNewDataVirtual, makeDataNonVirtual, makeDataVirtual, preview, removeAllAnnotationsFromData, removeTableModelListener, rowIsVirtual, setAcceptedDataType, setData, setDataAnnotation, setDataAnnotation, setNewDataVirtual, setTextAnnotation, setTextAnnotation, setValueAt, setVirtualData, setVirtualDataAnnotation, slice, toAnnotationTable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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, toDetailedString

Field Detail

LOCATION_KEY_NODE_NAME

public static final String LOCATION_KEY_NODE_NAME

To be used with getLocation(). Returns the node name if a node is set. Otherwise the default value is returned.

See Also:

Constant Field Values

LOCATION_KEY_NODE_DISPLAY_NAME

public static final String LOCATION_KEY_NODE_DISPLAY_NAME

To be used with getLocation(). Returns the node display name if a node is set. Otherwise the default value is returned.

See Also:

Constant Field Values

LOCATION_KEY_SLOT_NAME

public static final String LOCATION_KEY_SLOT_NAME

To be used with getLocation(). Returns the slot name.

See Also:

Constant Field Values

LOCATION_KEY_SLOT_DISPLAY_NAME

public static final String LOCATION_KEY_SLOT_DISPLAY_NAME

To be used with getLocation(). Returns the slot display name (contains the node name, and the slot's custom and internal name)

See Also:

Constant Field Values

LOCATION_KEY_SLOT_IO

public static final String LOCATION_KEY_SLOT_IO

To be used with getLocation(). Returns "Input" if the slot is and input. Returns "Output" if the slot is an output.

See Also:

Constant Field Values

Constructor Detail

JIPipeDataSlot

public JIPipeDataSlot(JIPipeDataSlotInfo info,
                      JIPipeGraphNode node)

Creates a new slot

Parameters:

info - the slot definition

node - The algorithm that contains the slot

JIPipeDataSlot

public JIPipeDataSlot(JIPipeDataSlot other,
                      boolean shallow,
                      JIPipeProgressInfo progressInfo)

Method Detail

createSingletonSlot

public static JIPipeInputDataSlot createSingletonSlot(JIPipeData data,
                                                      JIPipeGraphNode node)

Creates a new input slot that contains only one data item

Parameters:

data - the data

Returns:

the slot

getLocation

public String getLocation(String key,
                          String defaultValue)

Description copied from class: JIPipeDataTable

Returns info about the location of this data table. Returns the default value if no info with given key exists.

Overrides:

getLocation in class JIPipeDataTable

Parameters:

key - the key

defaultValue - returned if no info about the key exists

Returns:

the location. default value if no info is available

getName

public String getName()

Returns:

The unique slot name

getDisplayName

public String getDisplayName()

Returns a name that includes the algorithm name and the slot name. Should not be used outside of UI.

Overrides:

getDisplayName in class JIPipeDataTable

Returns:

Display name that includes the algorithm name, as well as the slot name.

getNode

public JIPipeGraphNode getNode()

Returns:

The node that contains the slot

setNode

public void setNode(JIPipeGraphNode node)

Reassigns the node

Parameters:

node - the node

getSlotType

public JIPipeSlotType getSlotType()

Returns:

The slot type

flush

public void flush(JIPipeProgressInfo saveProgress)

Saves the stored data to the provided storage path and sets data to null Warning: Ensure that depending input slots do not use this slot, anymore!

Parameters:

saveProgress - progress that reports the saving

isInput

public boolean isInput()

Returns:

True if this slot is an input slot

isOutput

public boolean isOutput()

Returns:

True if this slot is an output

getSlotStoragePath

public Path getSlotStoragePath()

Gets the storage path that is used during running the algorithm for saving the results This is not used during project creation

Returns:

Data storage path

setSlotStoragePath

public void setSlotStoragePath(Path slotStoragePath)

Sets storage path that is used during running the algorithm for saving the results

Parameters:

slotStoragePath - Data storage paths

getRowStoragePath

public Path getRowStoragePath(int index)

Gets the storage path of a data row from a result. This is not used during project creation.

Parameters:

index - row index

Returns:

path where the row's data is stored

exportToSlotStoragePath

public void exportToSlotStoragePath(JIPipeProgressInfo saveProgress)

Saves the data to the storage path Info: This method only works for output slots and saves to the storage path.

Parameters:

saveProgress - the progress for saving

getInfo

public JIPipeDataSlotInfo getInfo()

getStorageDataTablePath

public Path getStorageDataTablePath()

Only valid for slots generated by a JIPipeProjectRun. Returns the path to the data table file

Returns:

the data table path

getStorageDataTable

public JIPipeDataTableMetadata getStorageDataTable()

Only valid for slots generated by a JIPipeProjectRun. Returns the JIPipeDataTableMetadata from the data-table.json file

Returns:

the data table

toString

public String toString()

Overrides:

toString in class JIPipeDataTable

applyVirtualState

public void applyVirtualState(JIPipeProgressInfo progressInfo)

If virtual, put all data into the virtual storage If not, fetch all virtual data from storage This function reacts to the virtual mode setting in VirtualDataSettings and will refuse to make data virtual

Parameters:

progressInfo - the progress

getDescription

public String getDescription()