org.hkijena.jipipe.plugins.tables

Class TableColumnDataReference

java.lang.Object

org.hkijena.jipipe.plugins.tables.TableColumnDataReference

All Implemented Interfaces:

Closeable, AutoCloseable, JIPipeData, TableColumnData

public class TableColumnDataReference
extends Object
implements TableColumnData

A table column that references a column within a ResultsTableData

Constructor Summary

Constructors

Constructor and Description
TableColumnDataReference(ResultsTableData source, int sourceColumn)

Method Summary

Modifier and Type	Method and Description
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 double
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.plugins.tables.datatypes.TableColumnData

fromList, getDataAsObjectList, getRowAsObject, getSlice, isGeneratingTableColumn, isMutableTableColumn

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

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

Constructor Detail

TableColumnDataReference

public TableColumnDataReference(ResultsTableData source,
                                int sourceColumn)

Method Detail

getDataAsString

public String[] getDataAsString(int rows)

Description copied from interface: TableColumnData

Returns as many data entries as rows

Specified by:

getDataAsString in interface TableColumnData

Parameters:

rows - the number of rows

Returns:

Array with same length as rows

getDataAsDouble

public double[] getDataAsDouble(int rows)

Description copied from interface: TableColumnData

Returns as many data entries as rows

Specified by:

getDataAsDouble in interface TableColumnData

Parameters:

rows - the number of rows

Returns:

Array with same length as rows

getRowAsString

public String getRowAsString(int row)

Description copied from interface: TableColumnData

Returns the data entry as string

Specified by:

getRowAsString in interface TableColumnData

Parameters:

row - the row

Returns:

the data

getRowAsDouble

public double getRowAsDouble(int row)

Description copied from interface: TableColumnData

Returns the data entry as double

Specified by:

getRowAsDouble in interface TableColumnData

Parameters:

row - the row

Returns:

the data

getRows

public int getRows()

Description copied from interface: TableColumnData

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

Specified by:

getRows in interface TableColumnData

Returns:

the number of rows that are existing (not generated)

isNumeric

public boolean isNumeric()

Description copied from interface: TableColumnData

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

Specified by:

isNumeric in interface TableColumnData

Returns:

true if this column contains double entries.

isUserRemovable

public boolean isUserRemovable()

Description copied from interface: TableColumnData

Returns if users can remove this source

Specified by:

isUserRemovable in interface TableColumnData

Returns:

if users can remove this source

getLabel

public String getLabel()

Description copied from interface: TableColumnData

Label of this column

Specified by:

getLabel in interface TableColumnData

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