org.hkijena.jipipe.api.data

Class JIPipeDataTableMetadata

java.lang.Object

org.hkijena.jipipe.api.data.JIPipeDataTableMetadata

All Implemented Interfaces:

Iterable<JIPipeDataTableMetadataRow>, Collection<JIPipeDataTableMetadataRow>, List<JIPipeDataTableMetadataRow>, TableModel

public class JIPipeDataTableMetadata
extends Object
implements TableModel, List<JIPipeDataTableMetadataRow>

Contains all metadata exported from an JIPipeDataTable

Constructor Summary

Constructors

Constructor and Description
JIPipeDataTableMetadata()

Method Summary

Modifier and Type	Method and Description
void	add(int index, JIPipeDataTableMetadataRow element)
boolean	add(JIPipeDataTableMetadataRow row)
boolean	addAll(@NotNull Collection<? extends JIPipeDataTableMetadataRow> c)
boolean	addAll(int index, @NotNull Collection<? extends JIPipeDataTableMetadataRow> c)
void	addTableModelListener(TableModelListener l)
void	clear()
boolean	contains(Object o)
boolean	containsAll(@NotNull Collection<?> c)
JIPipeDataTableMetadataRow	get(int index)
String	getAcceptedDataTypeId()
List<String>	getAnnotationColumns()
Class<?>	getColumnClass(int columnIndex)
int	getColumnCount()
String	getColumnName(int columnIndex)
List<String>	getDataAnnotationColumns()
JIPipeDataInfo	getDataTypeOf(int rowIndex) Returns the true data type (if available) or the accepted data type of the given row
int	getFormatVersion() Returns the format version for storage in the JSON file.
int	getRowCount()
List<JIPipeDataTableMetadataRow>	getRowList()
Path	getRowStoragePath(Path storagePath, int row) Gets the storage path of the specified row
Object	getValueAt(int rowIndex, int columnIndex)
int	indexOf(Object o)
boolean	isCellEditable(int rowIndex, int columnIndex)
boolean	isEmpty()
@NotNull Iterator<JIPipeDataTableMetadataRow>	iterator()
int	lastIndexOf(Object o)
@NotNull ListIterator<JIPipeDataTableMetadataRow>	listIterator()
@NotNull ListIterator<JIPipeDataTableMetadataRow>	listIterator(int index)
static JIPipeDataTableMetadata	loadFromJson(Path fileName) Loads the table from JSON
JIPipeDataTableMetadataRow	remove(int index)
boolean	remove(Object o)
boolean	removeAll(@NotNull Collection<?> c)
void	removeTableModelListener(TableModelListener l)
boolean	retainAll(@NotNull Collection<?> c)
void	saveAsCSV(Path fileName) Saves the table to CSV
void	saveAsJson(Path fileName) Saves the table to JSON
JIPipeDataTableMetadataRow	set(int index, JIPipeDataTableMetadataRow element)
void	setAcceptedDataTypeId(String id) Sets the accepted datatype ID
void	setRowList(List<JIPipeDataTableMetadataRow> rowList) Sets list of rows
void	setValueAt(Object aValue, int rowIndex, int columnIndex)
int	size()
@NotNull List<JIPipeDataTableMetadataRow>	subList(int fromIndex, int toIndex)
int	toAnnotationColumnIndex(int columnIndex) Converts the column index to an annotation column index, or returns -1 if the column is not one
AnnotationTableData	toAnnotationTable() Converts the data table into an annotation table
@NotNull Object[]	toArray()
<T> T[]	toArray(T[] a)
int	toDataAnnotationColumnIndex(int columnIndex) Converts the column index to a data annotation column index, or returns -1 if the column is not one

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

JIPipeDataTableMetadata

public JIPipeDataTableMetadata()

Method Detail

loadFromJson

public static JIPipeDataTableMetadata loadFromJson(Path fileName)

Loads the table from JSON

Parameters:

fileName - JSON file

Returns:

Loaded table

getFormatVersion

public int getFormatVersion()

Returns the format version for storage in the JSON file. This might be used later to allow backward-compatibility

Returns:

the format version

getAcceptedDataTypeId

public String getAcceptedDataTypeId()

Returns:

The accepted datatype ID

setAcceptedDataTypeId

public void setAcceptedDataTypeId(String id)

Sets the accepted datatype ID

Parameters:

id - Datatype ID

getRowList

public List<JIPipeDataTableMetadataRow> getRowList()

Returns:

List of rows

setRowList

public void setRowList(List<JIPipeDataTableMetadataRow> rowList)

Sets list of rows

Parameters:

rowList - Row list

saveAsJson

public void saveAsJson(Path fileName)
                throws IOException

Saves the table to JSON

Parameters:

fileName - JSON file

Throws:

IOException - Triggered by ObjectMapper

getRowStoragePath

public Path getRowStoragePath(Path storagePath,
                              int row)

Gets the storage path of the specified row

Parameters:

storagePath - the storage path that contains the data table

row - the row index

Returns:

the path pointing to the data for the row

saveAsCSV

public void saveAsCSV(Path fileName)
               throws IOException

Saves the table to CSV

Parameters:

fileName - CSV file

Throws:

IOException - Triggered by ResultsTable

getDataAnnotationColumns

public List<String> getDataAnnotationColumns()

getAnnotationColumns

public List<String> getAnnotationColumns()

Returns:

Additional columns

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface TableModel

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface TableModel

toAnnotationColumnIndex

public int toAnnotationColumnIndex(int columnIndex)

Converts the column index to an annotation column index, or returns -1 if the column is not one

Parameters:

columnIndex - absolute column index

Returns:

relative annotation column index, or -1

toDataAnnotationColumnIndex

public int toDataAnnotationColumnIndex(int columnIndex)

Converts the column index to a data annotation column index, or returns -1 if the column is not one

Parameters:

columnIndex - absolute column index

Returns:

relative data annotation column index, or -1

getColumnName

public String getColumnName(int columnIndex)

Specified by:

getColumnName in interface TableModel

getColumnClass

public Class<?> getColumnClass(int columnIndex)

Specified by:

getColumnClass in interface TableModel

isCellEditable

public boolean isCellEditable(int rowIndex,
                              int columnIndex)

Specified by:

isCellEditable in interface TableModel

getValueAt

public Object getValueAt(int rowIndex,
                         int columnIndex)

Specified by:

getValueAt in interface TableModel

getDataTypeOf

public JIPipeDataInfo getDataTypeOf(int rowIndex)

Returns the true data type (if available) or the accepted data type of the given row

Parameters:

rowIndex - the row

Returns:

the data type

setValueAt

public void setValueAt(Object aValue,
                       int rowIndex,
                       int columnIndex)

Specified by:

setValueAt in interface TableModel

addTableModelListener

public void addTableModelListener(TableModelListener l)

Specified by:

addTableModelListener in interface TableModel

removeTableModelListener

public void removeTableModelListener(TableModelListener l)

Specified by:

removeTableModelListener in interface TableModel

toAnnotationTable

public AnnotationTableData toAnnotationTable()

Converts the data table into an annotation table

Returns:

the table

size

public int size()

Specified by:

size in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

size in interface List<JIPipeDataTableMetadataRow>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

isEmpty in interface List<JIPipeDataTableMetadataRow>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

contains in interface List<JIPipeDataTableMetadataRow>

iterator

@NotNull
public @NotNull Iterator<JIPipeDataTableMetadataRow> iterator()

Specified by:

iterator in interface Iterable<JIPipeDataTableMetadataRow>

Specified by:

iterator in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

iterator in interface List<JIPipeDataTableMetadataRow>

toArray

@NotNull
public @NotNull Object[] toArray()

Specified by:

toArray in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

toArray in interface List<JIPipeDataTableMetadataRow>

toArray

@NotNull
public <T> T[] toArray(@NotNull
                                T[] a)

Specified by:

toArray in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

toArray in interface List<JIPipeDataTableMetadataRow>

add

public boolean add(JIPipeDataTableMetadataRow row)

Specified by:

add in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

add in interface List<JIPipeDataTableMetadataRow>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

remove in interface List<JIPipeDataTableMetadataRow>

containsAll

public boolean containsAll(@NotNull
                           @NotNull Collection<?> c)

Specified by:

containsAll in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

containsAll in interface List<JIPipeDataTableMetadataRow>

addAll

public boolean addAll(@NotNull
                      @NotNull Collection<? extends JIPipeDataTableMetadataRow> c)

Specified by:

addAll in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

addAll in interface List<JIPipeDataTableMetadataRow>

addAll

public boolean addAll(int index,
                      @NotNull
                      @NotNull Collection<? extends JIPipeDataTableMetadataRow> c)

Specified by:

addAll in interface List<JIPipeDataTableMetadataRow>

removeAll

public boolean removeAll(@NotNull
                         @NotNull Collection<?> c)

Specified by:

removeAll in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

removeAll in interface List<JIPipeDataTableMetadataRow>

retainAll

public boolean retainAll(@NotNull
                         @NotNull Collection<?> c)

Specified by:

retainAll in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

retainAll in interface List<JIPipeDataTableMetadataRow>

clear

public void clear()

Specified by:

clear in interface Collection<JIPipeDataTableMetadataRow>

Specified by:

clear in interface List<JIPipeDataTableMetadataRow>

get

public JIPipeDataTableMetadataRow get(int index)

Specified by:

get in interface List<JIPipeDataTableMetadataRow>

set

public JIPipeDataTableMetadataRow set(int index,
                                      JIPipeDataTableMetadataRow element)

Specified by:

set in interface List<JIPipeDataTableMetadataRow>

add

public void add(int index,
                JIPipeDataTableMetadataRow element)

Specified by:

add in interface List<JIPipeDataTableMetadataRow>

remove

public JIPipeDataTableMetadataRow remove(int index)

Specified by:

remove in interface List<JIPipeDataTableMetadataRow>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<JIPipeDataTableMetadataRow>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<JIPipeDataTableMetadataRow>

listIterator

@NotNull
public @NotNull ListIterator<JIPipeDataTableMetadataRow> listIterator()

Specified by:

listIterator in interface List<JIPipeDataTableMetadataRow>

listIterator

@NotNull
public @NotNull ListIterator<JIPipeDataTableMetadataRow> listIterator(int index)

Specified by:

listIterator in interface List<JIPipeDataTableMetadataRow>

subList

@NotNull
public @NotNull List<JIPipeDataTableMetadataRow> subList(int fromIndex,
                                                                  int toIndex)

Specified by:

subList in interface List<JIPipeDataTableMetadataRow>