de.agentlab.ds.table

Class Table<S,T,V>

java.lang.Object

de.agentlab.ds.table.Table<S,T,V>

public class Table<S,T,V>
extends java.lang.Object

Container class for row/column data

Constructor Summary

Constructors

Constructor and Description
Table()
Table(java.util.Map<S,java.util.Map<T,V>> data)
Table(Table<S,T,V> m)

Method Summary

Modifier and Type	Method and Description
void	clear() Remove all data from the table.
boolean	contains(S rowKey, T colKey) Checks, if an element exists at a given position.
boolean	containsRowKey(S rowKey) Checks, if a row with a given key exists.
java.lang.String	format(RowKeyFormatter<S> rowKeyFormatter, ColKeyFormatter<T> colKeyFormatter, ValueFormatter<V> valueFormatter, java.util.Comparator<? super S> rowKeyComparator, java.util.Comparator<? super T> colKeyComparator, java.lang.String title, java.lang.String separator, java.lang.String separator2, boolean prettyfy)
V	get(S rowKey, T colKey) Provides the element at a given position.
java.util.List<V>	getCol(T colKey) Provides the column data for a given column key as list.
java.util.Set<T>	getColKeys()
java.util.List<T>	getColKeys(java.util.Comparator<T> comparator)
java.util.Map<S,java.util.Map<T,V>>	getData() Provides nested maps of the table data.
java.util.List<TableEntry<S,T,V>>	getEntries()
java.util.Set<KeyPair<S,T>>	getKeyPairs()
java.util.List<V>	getRow(S rowKey) Provides the row data for a given row key as list.
java.util.Set<S>	getRowKeys()
java.util.List<S>	getRowKeys(java.util.Comparator<S> comparator)
java.util.Map<T,V>	getRowMap(S rowKey) Provides the row data for a given row key as map.
boolean	isEmpty() Checks if the table is empty.
void	merge(Table<S,T,V> other) Merges the data of another table into this table.
void	moveRow(S fromRowKey, S toRowKey) Moves all data from a certain row key to another row key
void	put(S rowKey, T colKey) Stores a null data element at the given position, effectively just adding to row and column key.
void	put(S rowKey, T colKey, V value) Stores a data element at the given position.
void	putRow(S rowKey, java.util.Map<T,V> row) Add complete row of data for a certain row key.
V	remove(S rowKey, T colKey) Removes an element a the given position.
void	removeRow(S rowKey) Remove the row with the given key
void	setData(java.util.Map<S,java.util.Map<T,V>> data) Populates the table from nested maps.
int	size() Provides the size of this table.
java.lang.String	toCsv()
java.lang.String	toCsv(RowKeyFormatter<S> rowKeyFormatter, ColKeyFormatter<T> colKeyFormatter, ValueFormatter<V> valueFormatter, java.util.Comparator<? super S> rowKeyComparator, java.util.Comparator<? super T> colKeyComparator)
java.lang.String	toPrettyTable()
java.lang.String	toPrettyTable(boolean numericRowKeys)
java.lang.String	toPrettyTable(java.lang.String title, boolean numericRowKeys)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Table

public Table()

Table

public Table(Table<S,T,V> m)

Table

public Table(java.util.Map<S,java.util.Map<T,V>> data)

Method Detail

contains

public boolean contains(S rowKey,
                        T colKey)

Checks, if an element exists at a given position.

Parameters:

rowKey - the row key of the position

colKey - the column key of position

Returns:

true if an element exists at the given position, false otherwise

get

public V get(S rowKey,
             T colKey)

Provides the element at a given position.

Parameters:

rowKey - the row key of the position

colKey - the column key of position

Returns:

the element at the given position if such an element exists, null otherwise

containsRowKey

public boolean containsRowKey(S rowKey)

Checks, if a row with a given key exists.

Parameters:

rowKey - the row key

Returns:

true if an element exists at the given position, false otherwise

getRow

public java.util.List<V> getRow(S rowKey)

Provides the row data for a given row key as list.

Parameters:

rowKey - the row key

Returns:

the list of elements for the given row key

getRowMap

public java.util.Map<T,V> getRowMap(S rowKey)

Provides the row data for a given row key as map.

Parameters:

rowKey - the row key

Returns:

the map of elements for the given row key where each element is mapped by its column key

getCol

public java.util.List<V> getCol(T colKey)

Provides the column data for a given column key as list.

Parameters:

colKey - the col key

Returns:

the list of elements for the given column key

getRowKeys

public java.util.Set<S> getRowKeys()

Returns:

the set of all row keys

getRowKeys

public java.util.List<S> getRowKeys(java.util.Comparator<S> comparator)

getColKeys

public java.util.Set<T> getColKeys()

Returns:

the set of all column keys

getColKeys

public java.util.List<T> getColKeys(java.util.Comparator<T> comparator)

moveRow

public void moveRow(S fromRowKey,
                    S toRowKey)

Moves all data from a certain row key to another row key

Parameters:

fromRowKey - the origin row key

toRowKey - the target row key

putRow

public void putRow(S rowKey,
                   java.util.Map<T,V> row)

Add complete row of data for a certain row key. The row data is given as map of column keys to data elements.

Parameters:

rowKey - the key for the new row

row - the row data

put

public void put(S rowKey,
                T colKey,
                V value)

Stores a data element at the given position.

Parameters:

rowKey - the row key of the position

colKey - the column key of the position

value - the data element to store

put

public void put(S rowKey,
                T colKey)

Stores a null data element at the given position, effectively just adding to row and column key.

Parameters:

rowKey - the row key of the position

colKey - the column key of the position

removeRow

public void removeRow(S rowKey)

Remove the row with the given key

Parameters:

rowKey - the key of the row to remove

getData

public java.util.Map<S,java.util.Map<T,V>> getData()

Provides nested maps of the table data. The first level of the map maps the row keys to column maps. Each column map maps a column key to a data element.

Returns:

nested maps of the table data

setData

public void setData(java.util.Map<S,java.util.Map<T,V>> data)

Populates the table from nested maps. The first level of the map maps the row keys to column maps. Each column map maps a column key to a data element.

Parameters:

data - a map of maps with element data

remove

public V remove(S rowKey,
                T colKey)

Removes an element a the given position.

Parameters:

rowKey - the row key of the position

colKey - the column key of the position

Returns:

the removed element

getKeyPairs

public java.util.Set<KeyPair<S,T>> getKeyPairs()

Returns:

the set of KeyPair elements of the table data.

merge

public void merge(Table<S,T,V> other)

Merges the data of another table into this table. Each element of the other table is added at the position defined of the other table. If an element exists in this table, the element is overwritten.

Parameters:

other - the other table to merge

getEntries

public java.util.List<TableEntry<S,T,V>> getEntries()

Returns:

a list of TableEntry elements of this table

size

public int size()

Provides the size of this table. The size is defined as the number of data elements in the table.

Returns:

the size of this table.

clear

public void clear()

Remove all data from the table.

isEmpty

public boolean isEmpty()

Checks if the table is empty.

Returns:

true if the table is empty, false otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toCsv

public java.lang.String toCsv()

toCsv

public java.lang.String toCsv(RowKeyFormatter<S> rowKeyFormatter,
                              ColKeyFormatter<T> colKeyFormatter,
                              ValueFormatter<V> valueFormatter,
                              java.util.Comparator<? super S> rowKeyComparator,
                              java.util.Comparator<? super T> colKeyComparator)

toPrettyTable

public java.lang.String toPrettyTable()

toPrettyTable

public java.lang.String toPrettyTable(boolean numericRowKeys)

toPrettyTable

public java.lang.String toPrettyTable(java.lang.String title,
                                      boolean numericRowKeys)

format

public java.lang.String format(RowKeyFormatter<S> rowKeyFormatter,
                               ColKeyFormatter<T> colKeyFormatter,
                               ValueFormatter<V> valueFormatter,
                               java.util.Comparator<? super S> rowKeyComparator,
                               java.util.Comparator<? super T> colKeyComparator,
                               java.lang.String title,
                               java.lang.String separator,
                               java.lang.String separator2,
                               boolean prettyfy)