cn.sissors.hummingbird.collect

Class TableContainer<R,C,V>

java.lang.Object

cn.sissors.hummingbird.collect.TableContainer<R,C,V>

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

BinaryTableContainer, CSVTableContainer

public abstract class TableContainer<R,C,V>
extends Object
implements Cloneable, Serializable

A collection that associates an ordered pair of keys, called a row key and a column key, with a single value. A table may be sparse, with only a small fraction of row key / column key pairs possessing a corresponding value.

Version:

2018-10-12

Author:

zyz

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TableContainer(String headerName)

Method Summary

Modifier and Type	Method and Description
TableContainer<R,C,V>	clean() Clean all content in the container.
TableContainer<R,C,V>	clone()
List<C>	columnKeys() Get column keys organized as a List.
Map<C,Map<R,V>>	columnMap() Get the table organized by column keys.
static Long	CONTAINER_COUNT() Container id is an auto-increment attribute for identifying a container.
TableContainer<R,C,V>	filter(@Nullable Predicate<R> rowFilter, @Nullable Predicate<C> columnFilter) Cut current container through filters.
V	get(R row, C column) Get a cell based on (row, column).
String	getHeaderName()
abstract TableContainer<R,C,V>	load(String path) Load data from external storage into container.
TableContainer<R,C,V>	merge(TableContainer<R,C,V> other) Merge two containers into one and replaced the current.
String	NULL_CHARACTER_DISPLAY() Used for printing through console.
String	NULL_CHARACTER_DISPLAY(String NULL_CHARACTER_DISPLAY) Set customized NULL_CHARACTER_DISPLAY to replace NULL value when printing.
abstract void	persist(String path) Persist container data to external permanent storage.
String	print() Print the container to the console.
String	print(PrintStream printStream) Print the container to the specified print stream.
TableContainer<R,C,V>	push(R row, C column, V value) Push a cell into container.
List<R>	rowKeys() Get row keys organized as a List.
Map<R,Map<C,V>>	rowMap() Get the table organized by row keys.
void	setHeaderName(String headerName)
Map<R,V>	singleColumn(C column) Get a single column based on column key.
Map<C,V>	singleRow(R row) Get a single row based on row key.
TableContainer<R,C,V>	sort() Sort current container based on the dictionary order of row and column keys.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableContainer

public TableContainer(String headerName)

Method Detail

CONTAINER_COUNT

public static Long CONTAINER_COUNT()

Container id is an auto-increment attribute for identifying a container. The value of id just equals to the count of container that exists in memory.

Returns:

container count exists in memory

NULL_CHARACTER_DISPLAY

public String NULL_CHARACTER_DISPLAY()

Used for printing through console.

The NULL_CHARACTER_DISPLAY is used to replace NULL value.

Returns:

the character replaced for NULL

NULL_CHARACTER_DISPLAY

public String NULL_CHARACTER_DISPLAY(String NULL_CHARACTER_DISPLAY)

Set customized NULL_CHARACTER_DISPLAY to replace NULL value when printing.

Parameters:

NULL_CHARACTER_DISPLAY - the character replaced

Returns:

the character replaced for NULL

rowMap

public Map<R,Map<C,V>> rowMap()

Get the table organized by row keys.

Returns:

a nested map whose structure is (row, (column, value))

columnMap

public Map<C,Map<R,V>> columnMap()

Get the table organized by column keys.

Returns:

a nested map whose structure is (column, (row, value))

singleRow

public Map<C,V> singleRow(R row)

Get a single row based on row key.

Parameters:

row - row key

Returns:

a map whose structure is (column, value)

singleColumn

public Map<R,V> singleColumn(C column)

Get a single column based on column key.

Parameters:

column - column key

Returns:

a map whose structure is (row, value)

rowKeys

public List<R> rowKeys()

Get row keys organized as a List.

Returns:

a list that contains all row keys

columnKeys

public List<C> columnKeys()

Get column keys organized as a List.

Returns:

a list that contains all column keys

push

public TableContainer<R,C,V> push(R row,
                                  C column,
                                  V value)

Push a cell into container.

Parameters:

row - row key

column - column key

value - cell value

Returns:

container itself (easy to invoke under chain-style)

get

@Nullable
public V get(R row,
                       C column)

Get a cell based on (row, column).

Parameters:

row - row key

column - column key

Returns:

a single cell

clean

public TableContainer<R,C,V> clean()

Clean all content in the container.

Returns:

container itself (easy to invoke under chain-style)

persist

public abstract void persist(String path)
                      throws DataPersistenceException

Persist container data to external permanent storage.

Parameters:

path - external storage path

Throws:

DataPersistenceException - error appearance such as IOException and so on

load

public abstract TableContainer<R,C,V> load(String path)
                                    throws DataLoadingException

Load data from external storage into container.

Parameters:

path - external storage path

Returns:

the container that has been loaded

Throws:

DataLoadingException - error appearance such as IOException, IllegalValueTypeException and so on

merge

public TableContainer<R,C,V> merge(TableContainer<R,C,V> other)

Merge two containers into one and replaced the current.

Parameters:

other - another container with the sample (R, C, V) type

Returns:

current container

filter

public TableContainer<R,C,V> filter(@Nullable
                                    @Nullable Predicate<R> rowFilter,
                                    @Nullable
                                    @Nullable Predicate<C> columnFilter)

Cut current container through filters. If no filter on column or row, pass null.

Parameters:

rowFilter - the filter applied for row keys

columnFilter - the filter applied for column keys

Returns:

current container

sort

public TableContainer<R,C,V> sort()

Sort current container based on the dictionary order of row and column keys.

Returns:

sorted container

print

public String print()

Print the container to the console.

Returns:

the string for printing

print

public String print(PrintStream printStream)

Print the container to the specified print stream.

Parameters:

printStream - the stream to receive output

Returns:

the string for printing

clone

public TableContainer<R,C,V> clone()

Overrides:

clone in class Object

getHeaderName

public String getHeaderName()

setHeaderName

public void setHeaderName(String headerName)