de.tsl2.nano.collection

Class TableList<H extends Comparable<H>,ID>

java.lang.Object

de.tsl2.nano.collection.TableList<H,ID>

Type Parameters:

H - column-header type. to use the binarySearch of Arrays, H must implement Comparable

ID - row identifier type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FormTable

public class TableList<H extends Comparable<H>,ID>
extends Object
implements Serializable

Defines a table of values. A header defines the columns. The header array shouldn't hold any null values! All rows hold an index, a row-identifier and fixed sized array of values. The values are not typed, as it is possible to have different types in one row. Overwrite this class, if you have a static value type per column.

To work properly, your row-id type must implement the equals(Object) method correctly (see indexOf(Object).

Version:

$Revision$

Author:

Thomas Schneider

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CELL_ROOT
protected static String	DIV used by dumps
static String	FILE_EXT
protected H[]	header
protected Class<H>	headerType
protected static String	LF
protected String	name
protected List<de.tsl2.nano.collection.Row<ID>>	rows

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TableList()
protected	TableList(Class<H> headerType, H... header) base constructor
	TableList(Class<H> headerType, int columnCount) constructor to create any columns
	TableList(H... header) constructor
	TableList(String name, int columnCount) column headers will be of type String.
	TableList(String name, int cols, int rows)

Method Summary

Modifier and Type	Method and Description
TableList<H,ID>	add(ID rowId, Object... values) adds a new row to the table. if no values are given, an empty row will be added. if some values were given, but not the size of the header, an exception will be thrown
TableList<H,ID>	add(int index, ID rowId, Object... values) adds a new row to the table. if no values are given, an empty row will be added. if some values were given, but not the size of the header, an exception will be thrown
TableList<H,ID>	addAll(boolean includedRowIds, List values)
TableList<H,ID>	addAll(boolean includedRowIds, Object... values) addAll
protected void	checkColumnSize(int column)
protected void	checkRowSize(int row)
protected void	checkRowSize(Object... values)
protected void	checkSizes(int row, int column)
protected static Object	createDefaultHeader(Object source) wraps the given source string into a default header instance of this class. this implementatino simply returns the source string. each extension class shuold provide its own 'createDefaultHeader(string)'
protected de.tsl2.nano.collection.Row<ID>	createRow(int index, Object... values)
protected ID	createRowID(int i)
String	dump()
String	dump(String div, boolean resolve) dump
protected void	dumpValues(StringBuilder buf, String div, boolean resolve)
<T extends TableList<H,ID>> T	fill(Class<ID> idType, int rowCount) pre fill (e.g. a fixed sized table) with empty values
<T extends TableList<H,ID>> T	fill(ID... ids) pre fill the table - all values will be null
<T extends TableList<H,ID>> T	fill(int rowCount)
Object[]	get(ID rowId) gets row content directly. be careful using that method from outside. the base method get(int, int) is not used.
<S> S[]	get(ID rowId, Class<S> arrayType) convenience to get a row wrapped into a known object type. delegates to get(Object). no check will be done for the compatibility of the given array type!
Object	get(ID row, H column) get
Object	get(ID rowId, int column) get cell value
Object	get(int row, H column) get
Object	get(int row, int column) base implementation of getting a cell value. overwrite this method to do extended formatting.
int	getColumnCount() getColumnCount
String[]	getColumns() getColumns
H[]	getHeader()
String	getName()
int	getRowCount()
ID	getRowID(int row) getRowID
int	indexOf(ID rowId) like in List. works only, if row ID type implements its equals(Object) correctly.
static <T> T	load(String file)
static <T extends TableList> T	load(String file, Class<T> type)
static <T extends TableList> T	load(String file, Class<T> type, String div)
void	remove(ID rowId) remove row
de.tsl2.nano.collection.Row<ID>	remove(int index) remove row at given index
void	save(String relDir)
TableList<H,ID>	set(ID rowID, H column, Object value) resets an existing value of a given row and column of the table.
TableList<H,ID>	set(ID rowID, int column, Object value) resets an existing value of a given row and column of the table.
<S> TableList<H,ID>	set(ID rowId, S... values) convenience to refresh the values of the given row (the table-value instances wont change!).
TableList<H,ID>	set(int row, H column, Object value) resets an existing value of a given row and column of the table.
TableList<H,ID>	set(int index, ID rowId, Object... values) resets an existing row of the table. if no values are given, an empty row will be added. if some values were given, but not the size of the header, an exception will be thrown
TableList<H,ID>	set(int row, int column, Object value) resets an existing value of a given row and column of the table.
int	size() size
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

protected String name

headerType

protected Class<H extends Comparable<H>> headerType

header

protected H extends Comparable<H>[] header

rows

protected List<de.tsl2.nano.collection.Row<ID>> rows

DIV

protected static final String DIV

used by dumps

See Also:

Constant Field Values

LF

protected static final String LF

FILE_EXT

public static final String FILE_EXT

See Also:

Constant Field Values

CELL_ROOT

public static final String CELL_ROOT

See Also:

Constant Field Values

Constructor Detail

TableList

protected TableList()

TableList

public TableList(String name,
                 int cols,
                 int rows)

TableList

public TableList(String name,
                 int columnCount)

column headers will be of type String. see TableList(Class, int)

TableList

public TableList(Class<H> headerType,
                 int columnCount)

constructor to create any columns

Parameters:

headerType - header type. if String, the column names will have their index as column-text. On default, the default constructor of the header type will be called to create an instance.

columnCount - count of columns to create

TableList

public TableList(H... header)

constructor

Parameters:

header - array columns. must not be null and must contain at least one element!

TableList

protected TableList(Class<H> headerType,
                    H... header)

base constructor

Parameters:

header - column definitions

Method Detail

fill

public <T extends TableList<H,ID>> T fill(int rowCount)

fill

public <T extends TableList<H,ID>> T fill(Class<ID> idType,
                                          int rowCount)

pre fill (e.g. a fixed sized table) with empty values

Parameters:

idType - row identifier type

rowCount - rows to fill

fill

public <T extends TableList<H,ID>> T fill(ID... ids)

pre fill the table - all values will be null

Parameters:

ids - row identifiers

getHeader

public H[] getHeader()

Returns:

Returns the header.

getColumns

public String[] getColumns()

getColumns

Returns:

headers as string array

addAll

public TableList<H,ID> addAll(boolean includedRowIds,
                              List values)

addAll

public TableList<H,ID> addAll(boolean includedRowIds,
                              Object... values)

addAll

Parameters:

includedRowIds - if true, row-ids are included in the values

values - to be splitted and packed into col/rows

Returns:

tablelist itself

createRowID

protected ID createRowID(int i)

createRow

protected de.tsl2.nano.collection.Row<ID> createRow(int index,
                                                    Object... values)

add

public TableList<H,ID> add(ID rowId,
                           Object... values)

adds a new row to the table. if no values are given, an empty row will be added. if some values were given, but not the size of the header, an exception will be thrown

Parameters:

rowId - (optional) row identifier

values - row values

Returns:

the table object itself

add

public TableList<H,ID> add(int index,
                           ID rowId,
                           Object... values)

adds a new row to the table. if no values are given, an empty row will be added. if some values were given, but not the size of the header, an exception will be thrown

Parameters:

index - row index

rowId - (optional) row identifier

values - row values

Returns:

the table object itself

set

public TableList<H,ID> set(int index,
                           ID rowId,
                           Object... values)

resets an existing row of the table. if no values are given, an empty row will be added. if some values were given, but not the size of the header, an exception will be thrown

Parameters:

index - row index

rowId - (optional) new row identifier

values - row values

Returns:

the table object itself

set

public <S> TableList<H,ID> set(ID rowId,
                               S... values)

convenience to refresh the values of the given row (the table-value instances wont change!). the instances of values might be gotten through get(Object, Class).no check will be done for the compatibility of the given array type!

Parameters:

rowId - row identifier

values - new values to be copied to the table row

Returns:

table itself

set

public TableList<H,ID> set(int row,
                           int column,
                           Object value)

resets an existing value of a given row and column of the table.

Parameters:

row - index index

column - column index

values - row values

Returns:

the table object itself

set

public TableList<H,ID> set(int row,
                           H column,
                           Object value)

resets an existing value of a given row and column of the table.

Parameters:

row - index index

column - column index

values - row values

Returns:

the table object itself

set

public TableList<H,ID> set(ID rowID,
                           int column,
                           Object value)

resets an existing value of a given row and column of the table.

Parameters:

row - index index

column - column index

values - row values

Returns:

the table object itself

set

public TableList<H,ID> set(ID rowID,
                           H column,
                           Object value)

resets an existing value of a given row and column of the table.

Parameters:

row - index index

column - column index

values - row values

Returns:

the table object itself

remove

public void remove(ID rowId)

remove row

Parameters:

rowId - row identifier

remove

public de.tsl2.nano.collection.Row<ID> remove(int index)

remove row at given index

Parameters:

index - row index

Returns:

removed row

get

public Object get(int row,
                  int column)

base implementation of getting a cell value. overwrite this method to do extended formatting.

Parameters:

rowId - row identifer

column - column identifier

Returns:

cell value

Throws:

NullPointerException - if rowId couldn't be found

get

public Object get(ID row,
                  H column)

get

Parameters:

rowId - row identifer

column - column identifier

Returns:

cell value

Throws:

NullPointerException - if rowId couldn't be found

get

public Object get(int row,
                  H column)

get

Parameters:

row - row index

column - column identifier

Returns:

cell value or null

getRowID

public ID getRowID(int row)

getRowID

Parameters:

row - row index

Returns:

row identifier

get

public Object[] get(ID rowId)

gets row content directly. be careful using that method from outside. the base method get(int, int) is not used.

Parameters:

rowId - row identifier

arrType - array type. this must be the type, you gave on constructing this class! the value-array will not be changed!

Returns:

row values

get

public <S> S[] get(ID rowId,
                   Class<S> arrayType)

convenience to get a row wrapped into a known object type. delegates to get(Object). no check will be done for the compatibility of the given array type! the returned array is a copy of th origin table row. please see set(Object, Object...) to refresh your changed values.

Type Parameters:

S - array type to pack the given row into.

Parameters:

rowId - row values to be returned

arrayType - array type

Returns:

array filled with row values

get

public Object get(ID rowId,
                  int column)

get cell value

Parameters:

rowId - row identifer

column - column identifier

Returns:

cell value

Throws:

ArrayIndexOutOfBoundsException - if rowId couldn't be found

indexOf

public int indexOf(ID rowId)

like in List. works only, if row ID type implements its equals(Object) correctly.

Parameters:

rowId -

Returns:

size

public int size()

size

Returns:

count of rows

getColumnCount

public int getColumnCount()

getColumnCount

Returns:

count of header columns

getRowCount

public int getRowCount()

checkSizes

protected final void checkSizes(int row,
                                int column)

checkRowSize

protected final void checkRowSize(int row)

checkColumnSize

protected final void checkColumnSize(int column)

checkRowSize

protected final void checkRowSize(Object... values)

save

public void save(String relDir)

getName

public String getName()

Returns:

Returns the name.

load

public static <T> T load(String file)

load

public static <T extends TableList> T load(String file,
                                           Class<T> type)

load

public static <T extends TableList> T load(String file,
                                           Class<T> type,
                                           String div)

createDefaultHeader

protected static Object createDefaultHeader(Object source)

wraps the given source string into a default header instance of this class. this implementatino simply returns the source string. each extension class shuold provide its own 'createDefaultHeader(string)'

Parameters:

source - header to be wrapped

Returns:

wrapped source

dump

public String dump()

dump

public String dump(String div,
                   boolean resolve)

dump

Returns:

dumpValues

protected void dumpValues(StringBuilder buf,
                          String div,
                          boolean resolve)

toString

public String toString()

Overrides:

toString in class Object