org.scijava.table

Interface Table<C extends Column<? extends T>,T>

Type Parameters:

C - The type of column used by the table.

T - The type of data stored in the table.

All Superinterfaces:

Collection<C>, Iterable<C>, List<C>

All Known Subinterfaces:

BoolTable, ByteTable, CharTable, DoubleTable, FloatTable, GenericTable, IntTable, LongTable, ShortTable

All Known Implementing Classes:

AbstractTable, DefaultBoolTable, DefaultByteTable, DefaultCharTable, DefaultDoubleTable, DefaultFloatTable, DefaultGenericTable, DefaultIntTable, DefaultLongTable, DefaultShortTable

public interface Table<C extends Column<? extends T>,T>
extends List<C>

A table of values.

Author:

Curtis Rueden

Method Summary

Modifier and Type	Method and Description
boolean	add(C column) Appends the specified column to the end of the table.
void	add(int col, C column) Inserts the specified column at the specified position in the table.
boolean	addAll(Collection<? extends C> c) Appends all of the columns in the specified collection to the end of the table, in the order that they are returned by the specified collection's iterator.
boolean	addAll(int col, Collection<? extends C> c) Inserts all of the columns in the specified collection into this list at the specified position.
C	appendColumn() Appends a column (with no header) to the table.
C	appendColumn(String header) Appends a column with the given header to the table.
List<C>	appendColumns(int count) Appends a number of columns (with no headers) to the table.
List<C>	appendColumns(String... headers) Appends a block of columns with the given headers to the table.
void	appendRow() Appends a row (with no header) to the table.
void	appendRow(String header) Appends a row with the given header to the table.
void	appendRows(int count) Appends a block of rows (with no headers) to the table.
void	appendRows(String... headers) Appends a block of rows with the given headers to the table.
void	clear() Removes all data (including row and column headers) from the table.
boolean	contains(Object column) Gets whether the table contains the given column.
boolean	containsAll(Collection<?> c) Returns true if the table contains all of the columns of the specified collection.
C	get(int col) Returns the column at the specified position in the table.
T	get(int col, int row) Gets the table value at the given column and row.
C	get(String colHeader) Returns the first column with the given header in the table.
T	get(String colHeader, int row) Gets the table value at the given column and row.
int	getColumnCount() Gets the number of columns in the table.
String	getColumnHeader(int col) Gets the column header at the given column.
int	getColumnIndex(String header) Gets the column index of the column with the given header.
int	getRowCount() Gets the number of rows in the table.
String	getRowHeader(int row) Gets the row header at the given row.
int	getRowIndex(String header) Gets the row index of the row with the given header.
int	indexOf(Object column) Returns the index of the first occurrence of the specified column in the table, or -1 if the table does not contain the column.
C	insertColumn(int col) Inserts a column (with no header) at the given position in the table.
C	insertColumn(int col, String header) Inserts a column with the specified header at the given position in the table.
List<C>	insertColumns(int col, int count) Inserts a block of columns (with no headers) at the given position in the table.
List<C>	insertColumns(int col, String... headers) Inserts a block of columns with the specified headers at the given position in the table.
void	insertRow(int row) Inserts a row (with no header) at the given position in the table.
void	insertRow(int row, String header) Inserts a row with the specified header at the given position in the table.
void	insertRows(int row, int count) Inserts a block of rows (with no headers) at the given position in the table.
void	insertRows(int row, String... headers) Inserts a block of rows with the specified headers at the given position in the table.
boolean	isEmpty() Gets whether the table is empty.
Iterator<C>	iterator() Returns an iterator over the columns in the table in proper sequence.
int	lastIndexOf(Object column) Returns the index of the last occurrence of the specified column in the table, or -1 if the table does not contain the column.
ListIterator<C>	listIterator() Returns a list iterator over the columns in the table (in proper sequence).
ListIterator<C>	listIterator(int col) Returns a list iterator of the columns in the table (in proper sequence), starting at the specified position in the table.
C	remove(int col) Removes the column at the specified position in the table.
boolean	remove(Object column) Removes the first occurrence of the specified column from the table, if it is present.
boolean	removeAll(Collection<?> c) Removes from the table all of its columns that are contained in the specified collection.
C	removeColumn(int col) Removes the column at the given position from the table.
C	removeColumn(String header) Removes the first column with the given header from the table.
List<C>	removeColumns(int col, int count) Removes a block of columns starting at the given position from the table.
List<C>	removeColumns(String... headers) Removes the first columns with the given headers from the table.
void	removeRow(int row) Removes the row at the given position from the table.
void	removeRow(String header) Removes the first row with the given header from the table.
void	removeRows(int row, int count) Removes a block of rows starting at the given position from the table.
void	removeRows(String... headers) Removes the first rows with the given headers from the table.
boolean	retainAll(Collection<?> c) Retains only the columns in the table that are contained in the specified collection.
C	set(int col, C column) Replaces the column at the specified position in the table with the specified column.
void	set(int col, int row, T value) Sets the table value at the given column and row.
void	set(String colHeader, int row, T value) Sets the table value at the given column and row.
void	setColumnCount(int colCount) Sets the number of columns in the table.
void	setColumnHeader(int col, String header) Sets the column header at the given column.
void	setDimensions(int colCount, int rowCount) Sets the number of columns and rows in the table.
void	setRowCount(int rowCount) Sets the number of rows in the table.
void	setRowHeader(int row, String header) Sets the row header at the given row.
int	size() Gets the number of columns in the table.
List<C>	subList(int fromCol, int toCol) Returns a view of the portion of the table between the specified fromIndex, inclusive, and toIndex, exclusive.
Object[]	toArray() Returns an array containing all of the columns in the table in proper sequence (from first to last column).
<A> A[]	toArray(A[] a) Returns an array containing all of the column in the table in proper sequence (from first to last column); the runtime type of the returned array is that of the specified array.

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

Method Detail

getColumnCount

int getColumnCount()

Gets the number of columns in the table.

setColumnCount

void setColumnCount(int colCount)

Sets the number of columns in the table.

get

C get(String colHeader)

Returns the first column with the given header in the table.

appendColumn

C appendColumn()

Appends a column (with no header) to the table.

Returns:

the column that was appended

appendColumn

C appendColumn(String header)

Appends a column with the given header to the table.

Returns:

the column that was appended

appendColumns

List<C> appendColumns(int count)

Appends a number of columns (with no headers) to the table.

Returns:

the columns that were appended

appendColumns

List<C> appendColumns(String... headers)

Appends a block of columns with the given headers to the table.

Returns:

the columns that were appended

insertColumn

C insertColumn(int col)

Inserts a column (with no header) at the given position in the table.

Returns:

the column that was inserted

insertColumn

C insertColumn(int col,
               String header)

Inserts a column with the specified header at the given position in the table.

Returns:

the column that was inserted

insertColumns

List<C> insertColumns(int col,
                      int count)

Inserts a block of columns (with no headers) at the given position in the table.

Returns:

the columns that were inserted

insertColumns

List<C> insertColumns(int col,
                      String... headers)

Inserts a block of columns with the specified headers at the given position in the table.

Returns:

the columns that were inserted

removeColumn

C removeColumn(int col)

Removes the column at the given position from the table.

Returns:

the column that was removed

removeColumn

C removeColumn(String header)

Removes the first column with the given header from the table.

Returns:

the column that was removed

removeColumns

List<C> removeColumns(int col,
                      int count)

Removes a block of columns starting at the given position from the table.

Returns:

the columns that were removed

removeColumns

List<C> removeColumns(String... headers)

Removes the first columns with the given headers from the table.

Returns:

the columns that were removed

getRowCount

int getRowCount()

Gets the number of rows in the table.

setRowCount

void setRowCount(int rowCount)

Sets the number of rows in the table.

appendRow

void appendRow()

Appends a row (with no header) to the table.

appendRow

void appendRow(String header)

Appends a row with the given header to the table.

appendRows

void appendRows(int count)

Appends a block of rows (with no headers) to the table.

appendRows

void appendRows(String... headers)

Appends a block of rows with the given headers to the table.

insertRow

void insertRow(int row)

Inserts a row (with no header) at the given position in the table.

insertRow

void insertRow(int row,
               String header)

Inserts a row with the specified header at the given position in the table.

insertRows

void insertRows(int row,
                int count)

Inserts a block of rows (with no headers) at the given position in the table.

insertRows

void insertRows(int row,
                String... headers)

Inserts a block of rows with the specified headers at the given position in the table.

removeRow

void removeRow(int row)

Removes the row at the given position from the table.

removeRow

void removeRow(String header)

Removes the first row with the given header from the table.

removeRows

void removeRows(int row,
                int count)

Removes a block of rows starting at the given position from the table.

removeRows

void removeRows(String... headers)

Removes the first rows with the given headers from the table.

setDimensions

void setDimensions(int colCount,
                   int rowCount)

Sets the number of columns and rows in the table.

getColumnHeader

String getColumnHeader(int col)

Gets the column header at the given column.

setColumnHeader

void setColumnHeader(int col,
                     String header)

Sets the column header at the given column.

getColumnIndex

int getColumnIndex(String header)

Gets the column index of the column with the given header.

getRowHeader

String getRowHeader(int row)

Gets the row header at the given row.

setRowHeader

void setRowHeader(int row,
                  String header)

Sets the row header at the given row.

getRowIndex

int getRowIndex(String header)

Gets the row index of the row with the given header.

set

void set(int col,
         int row,
         T value)

Sets the table value at the given column and row.

set

void set(String colHeader,
         int row,
         T value)

Sets the table value at the given column and row.

get

T get(int col,
      int row)

Gets the table value at the given column and row.

get

T get(String colHeader,
      int row)

Gets the table value at the given column and row.

size

int size()

Gets the number of columns in the table.

Specified by:

size in interface Collection<C extends Column<? extends T>>

Specified by:

size in interface List<C extends Column<? extends T>>

isEmpty

boolean isEmpty()

Gets whether the table is empty.

Specified by:

isEmpty in interface Collection<C extends Column<? extends T>>

Specified by:

isEmpty in interface List<C extends Column<? extends T>>

contains

boolean contains(Object column)

Gets whether the table contains the given column.

Specified by:

contains in interface Collection<C extends Column<? extends T>>

Specified by:

contains in interface List<C extends Column<? extends T>>

Parameters:

column - The Column whose presence in the table is to be tested.

iterator

Iterator<C> iterator()

Returns an iterator over the columns in the table in proper sequence.

Specified by:

iterator in interface Collection<C extends Column<? extends T>>

Specified by:

iterator in interface Iterable<C extends Column<? extends T>>

Specified by:

iterator in interface List<C extends Column<? extends T>>

toArray

Object[] toArray()

Returns an array containing all of the columns in the table in proper sequence (from first to last column).

Specified by:

toArray in interface Collection<C extends Column<? extends T>>

Specified by:

toArray in interface List<C extends Column<? extends T>>

toArray

<A> A[] toArray(A[] a)

Returns an array containing all of the column in the table in proper sequence (from first to last column); the runtime type of the returned array is that of the specified array. If the list of columns fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list of columns.

Specified by:

toArray in interface Collection<C extends Column<? extends T>>

Specified by:

toArray in interface List<C extends Column<? extends T>>

add

boolean add(C column)

Appends the specified column to the end of the table.

Updates the row count if this column has more rows than current table and scales the existing columns to have the same number of rows.

Specified by:

add in interface Collection<C extends Column<? extends T>>

Specified by:

add in interface List<C extends Column<? extends T>>

remove

boolean remove(Object column)

Removes the first occurrence of the specified column from the table, if it is present.

Specified by:

remove in interface Collection<C extends Column<? extends T>>

Specified by:

remove in interface List<C extends Column<? extends T>>

Returns:

true if the table contained the specified column

containsAll

boolean containsAll(Collection<?> c)

Returns true if the table contains all of the columns of the specified collection.

Specified by:

containsAll in interface Collection<C extends Column<? extends T>>

Specified by:

containsAll in interface List<C extends Column<? extends T>>

addAll

boolean addAll(Collection<? extends C> c)

Appends all of the columns in the specified collection to the end of the table, in the order that they are returned by the specified collection's iterator.

Updates the row count if necessary, and scales the columns to match the row count if necessary.

Specified by:

addAll in interface Collection<C extends Column<? extends T>>

Specified by:

addAll in interface List<C extends Column<? extends T>>

Returns:

true if the table changed as a result of the call

addAll

boolean addAll(int col,
               Collection<? extends C> c)

Inserts all of the columns in the specified collection into this list at the specified position.

Updates the row count if necessary, and scales the columns to match the row count if necessary.

Specified by:

addAll in interface List<C extends Column<? extends T>>

Returns:

true if the table changed as a result of the call

removeAll

boolean removeAll(Collection<?> c)

Removes from the table all of its columns that are contained in the specified collection.

Specified by:

removeAll in interface Collection<C extends Column<? extends T>>

Specified by:

removeAll in interface List<C extends Column<? extends T>>

Returns:

true if the table changed as a result of the call

retainAll

boolean retainAll(Collection<?> c)

Retains only the columns in the table that are contained in the specified collection. In other words, removes from the table all the columns that are not contained in the specified collection.

Specified by:

retainAll in interface Collection<C extends Column<? extends T>>

Specified by:

retainAll in interface List<C extends Column<? extends T>>

Returns:

true if the table changed as a result of the call

clear

void clear()

Removes all data (including row and column headers) from the table. The table will be empty after this call returns.

If you want to retain the column headers, call setRowCount(int) with a value of 0. If you want to retain the row headers, call setColumnCount(int) with a value of 0.

Specified by:

clear in interface Collection<C extends Column<? extends T>>

Specified by:

clear in interface List<C extends Column<? extends T>>

get

C get(int col)

Returns the column at the specified position in the table.

Specified by:

get in interface List<C extends Column<? extends T>>

set

C set(int col,
      C column)

Replaces the column at the specified position in the table with the specified column.

No checking is done to ensure the new column has the same number of rows as the other existing columns.

Specified by:

set in interface List<C extends Column<? extends T>>

Returns:

the column previously at the specified position

add

void add(int col,
         C column)

Inserts the specified column at the specified position in the table.

Updates the row count if this column has more rows than current table and scales the existing columns to have the same number of rows.

Specified by:

add in interface List<C extends Column<? extends T>>

remove

C remove(int col)

Removes the column at the specified position in the table.

Specified by:

remove in interface List<C extends Column<? extends T>>

Returns:

the column previously at the specified position

indexOf

int indexOf(Object column)

Returns the index of the first occurrence of the specified column in the table, or -1 if the table does not contain the column.

Specified by:

indexOf in interface List<C extends Column<? extends T>>

lastIndexOf

int lastIndexOf(Object column)

Returns the index of the last occurrence of the specified column in the table, or -1 if the table does not contain the column.

Specified by:

lastIndexOf in interface List<C extends Column<? extends T>>

listIterator

ListIterator<C> listIterator()

Returns a list iterator over the columns in the table (in proper sequence).

Specified by:

listIterator in interface List<C extends Column<? extends T>>

listIterator

ListIterator<C> listIterator(int col)

Returns a list iterator of the columns in the table (in proper sequence), starting at the specified position in the table.

Specified by:

listIterator in interface List<C extends Column<? extends T>>

subList

List<C> subList(int fromCol,
                int toCol)

Returns a view of the portion of the table between the specified fromIndex, inclusive, and toIndex, exclusive. The returned list is backed by the table, so non-structural changes in the returned list are reflected in the table, and vice-versa.

Specified by:

subList in interface List<C extends Column<? extends T>>