edu.stanford.math.plex4.io

Class Table

java.lang.Object

edu.stanford.math.plex4.io.Table

public class Table
extends java.lang.Object

This class holds a table of string values. It contains functionality for outputting in comma separated and pretty printed formats.

Author:

Andrew Tausz

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.ArrayList<java.lang.String>	columnHeadings
protected int	numColumns
protected int	numRows
protected java.util.ArrayList<java.util.ArrayList<java.lang.String>>	rows
protected java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
Table()

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumn(java.lang.String columnHeading) This function adds a new column to the table.
void	addRow(java.util.Collection<java.lang.Object> row) This function adds a data row to the table.
void	addRow(java.util.List<java.lang.String> row) This function adds a data row to the table.
void	addRow(java.lang.String[] row, boolean trimElements) This function adds a data row to the table.
java.lang.String	getColumnHeading(int column) This function returns the heading of the specified column.
java.lang.String	getEntry(int row, int column) This function returns the entry in the table located at (row, column).
java.lang.String	getTitle() This function returns the title of the table.
void	setColumnHeading(int column, java.lang.String columnHeading) This function sets the heading of the specified column.
void	setTitle(java.lang.String title) This function sets the title of the table.
java.lang.String	toCSVString(java.lang.String separator, boolean includeTitle, boolean includeHeadings) This function creates a string holding the contents of the table in comma separated format.
java.lang.String	toPrettyString(java.lang.String separator) This function returns a string holding the contents of the table.
java.lang.String	toString() This function returns the string representation of the table.

Methods inherited from class java.lang.Object

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

Field Detail

title

protected java.lang.String title

numColumns

protected int numColumns

numRows

protected int numRows

columnHeadings

protected java.util.ArrayList<java.lang.String> columnHeadings

rows

protected java.util.ArrayList<java.util.ArrayList<java.lang.String>> rows

Constructor Detail

Table

public Table()

Method Detail

setTitle

public void setTitle(java.lang.String title)

This function sets the title of the table.

Parameters:

title - the title to set to

getTitle

public java.lang.String getTitle()

This function returns the title of the table.

Returns:

the table's title

addColumn

public void addColumn(java.lang.String columnHeading)

This function adds a new column to the table.

Parameters:

columnHeading - the name of the column to add

setColumnHeading

public void setColumnHeading(int column,
                    java.lang.String columnHeading)

This function sets the heading of the specified column.

Parameters:

column - the index of the column

columnHeading - the new heading of the column

getColumnHeading

public java.lang.String getColumnHeading(int column)

This function returns the heading of the specified column.

Parameters:

column - the index of the column

Returns:

the heading of the specified column

addRow

public void addRow(java.util.Collection<java.lang.Object> row)

This function adds a data row to the table. It converts each object in the input to a string, by calling the toString function.

Parameters:

row - a collection containing the data to add

addRow

public void addRow(java.util.List<java.lang.String> row)

This function adds a data row to the table.

Parameters:

row - a collection containing the data to add

addRow

public void addRow(java.lang.String[] row,
          boolean trimElements)

This function adds a data row to the table.

Parameters:

row - a collection containing the data to add

getEntry

public java.lang.String getEntry(int row,
                        int column)

This function returns the entry in the table located at (row, column).

Parameters:

row - the row of the entry

column - the column of the entry

Returns:

the element at the specified location

toString

public java.lang.String toString()

This function returns the string representation of the table. For now it uses the pretty print version.

Overrides:

toString in class java.lang.Object

toCSVString

public java.lang.String toCSVString(java.lang.String separator,
                           boolean includeTitle,
                           boolean includeHeadings)

This function creates a string holding the contents of the table in comma separated format.

Parameters:

separator - the separator between each column

includeTitle - if true, then the title is also printed

includeHeadings - if true, then the headings are printed

Returns:

a string containing the contents of the table

toPrettyString

public java.lang.String toPrettyString(java.lang.String separator)

This function returns a string holding the contents of the table. It pads the columns with spaces so that the columns have uniform width.

Returns:

a visually appealing textual representation of the table