org.perfidix.ouput.asciitable

Class NiceTable

java.lang.Object

org.perfidix.ouput.asciitable.NiceTable

public final class NiceTable
extends Object

This class represents a table which allows formatting of data as an ascii table. it takes care of automatically adjusting widths of the tables. A word on the orientations: at the current point of development, the orientation works on COLUMNS and NOT on ROWs. so you can set the orientation of a full ROW, but you cannot set the orientation for each field[x][y] in the table.

Author:

Alexander Onea, neue Couch, Sebastian Graf, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
NiceTable(int numberOfColumns) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String title) Adds a header.
void	addHeader(String title, char mark, AbstractTabularComponent.Alignment orientation) Adds a header row to the table.
void	addLine(char fill) allows the addition of lines.
void	addRow(String[] data) Adds a string row.
protected int	getColumnWidth(int columnIndex) Returns the global column width at index columnIndex.
protected AbstractTabularComponent.Alignment	getOrientation(int columnIndex) Returns the orientation of a column.
protected int	getTotalWidth() Returns the total width of the table.
String	toString() the main method doing the work.
protected void	updateColumnWidth(int index, int newSize) Performs an update on the column lengths.

Methods inherited from class java.lang.Object

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

Constructor Detail

NiceTable

public NiceTable(int numberOfColumns)

Constructor. needs the number of columns to show.

Parameters:

numberOfColumns - the number of columns to display.

Method Detail

addHeader

public void addHeader(String title)

Adds a header.

Parameters:

title - the text to display within the header

addHeader

public void addHeader(String title,
             char mark,
             AbstractTabularComponent.Alignment orientation)

Adds a header row to the table. can be used to give a table some title.

  addHeader("hello",'.',NiceTable.LEFT)
  would produce a row like
  ... hello ..........................
   {rows in here.}
 

Parameters:

title - the string to display as a header

mark - the mark to use for the rest of the column

orientation - the orientation of the header column.

addRow

public void addRow(String[] data)

Adds a string row. checks that the strings added do not contain newlines, because if so, it has to split them in order to make them fit the row.

Parameters:

data - the array of data.

addLine

public void addLine(char fill)

allows the addition of lines. think of it as a horizontal rule in a table.

Parameters:

fill - any character with which to draw the line.

toString

public String toString()

the main method doing the work. draws everyting.

Overrides:

toString in class Object

Returns:

the formatted table.

getColumnWidth

protected int getColumnWidth(int columnIndex)

Returns the global column width at index columnIndex.

Parameters:

columnIndex - the index of the column for which to fetch the width.

Returns:

the width (in number of chars) for the column index.

updateColumnWidth

protected void updateColumnWidth(int index,
                     int newSize)

Performs an update on the column lengths.

Parameters:

index - the index of the column

newSize - the new size of the column

getOrientation

protected AbstractTabularComponent.Alignment getOrientation(int columnIndex)

Returns the orientation of a column.

Parameters:

columnIndex - integer

Returns:

Alignment for the column

getTotalWidth

protected int getTotalWidth()

Returns the total width of the table.

Returns:

int the width of the table