org.hkijena.jipipe.extensions.tables

Class TableColumnReference

java.lang.Object

org.hkijena.jipipe.extensions.tables.TableColumnReference

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData, TableColumn

public class TableColumnReference
extends Object
implements TableColumn

A table column that references a column within a ResultsTableData

Constructor Summary

Constructors

Constructor and Description
TableColumnReference(ResultsTableData source, int sourceColumn)

Method Summary

Modifier and Type	Method and Description
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
double[]	getDataAsDouble(int rows) Returns as many data entries as rows
String[]	getDataAsString(int rows) Returns as many data entries as rows
String	getLabel() Label of this column
double	getRowAsDouble(int row) Returns the data entry as string
String	getRowAsString(int row) Returns the data entry as string
int	getRows() Returns the number of rows that are existing (not generated)
boolean	isNumeric() Returns true if this column contains double entries.
boolean	isUserRemovable() Returns if users can remove this source

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.extensions.tables.datatypes.TableColumn

getDataAsObjectList, getRowAsObject, getSlice, isGeneratingTableColumn, isMutableTableColumn

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

close, exportThumbnails, getDescriptionOf, getMenuPathOf, getNameOf, getSortedList, getStorageDocumentation, getStorageSchema, groupByMenuPath, isCommon, isHeavy, isHidden, preview, toDetailedString

Constructor Detail

TableColumnReference

public TableColumnReference(ResultsTableData source,
                            int sourceColumn)

Method Detail

getDataAsString

public String[] getDataAsString(int rows)

Description copied from interface: TableColumn

Returns as many data entries as rows

Specified by:

getDataAsString in interface TableColumn

Parameters:

rows - the number of rows

Returns:

Array with same length as rows

getDataAsDouble

public double[] getDataAsDouble(int rows)

Description copied from interface: TableColumn

Returns as many data entries as rows

Specified by:

getDataAsDouble in interface TableColumn

Parameters:

rows - the number of rows

Returns:

Array with same length as rows

getRowAsString

public String getRowAsString(int row)

Description copied from interface: TableColumn

Returns the data entry as string

Specified by:

getRowAsString in interface TableColumn

Parameters:

row - the row

Returns:

the data

getRowAsDouble

public double getRowAsDouble(int row)

Description copied from interface: TableColumn

Returns the data entry as string

Specified by:

getRowAsDouble in interface TableColumn

Parameters:

row - the row

Returns:

the data

getRows

public int getRows()

Description copied from interface: TableColumn

Returns the number of rows that are existing (not generated)

Specified by:

getRows in interface TableColumn

Returns:

the number of rows that are existing (not generated)

isNumeric

public boolean isNumeric()

Description copied from interface: TableColumn

Returns true if this column contains double entries. If false, it contains String entries.

Specified by:

isNumeric in interface TableColumn

Returns:

true if this column contains double entries.

isUserRemovable

public boolean isUserRemovable()

Description copied from interface: TableColumn

Returns if users can remove this source

Specified by:

isUserRemovable in interface TableColumn

Returns:

if users can remove this source

getLabel

public String getLabel()

Description copied from interface: TableColumn

Label of this column

Specified by:

getLabel in interface TableColumn

Returns:

the label

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

display

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

Description copied from interface: JIPipeData

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.

Specified by:

display in interface JIPipeData

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)