de.vandermeer.asciitable.v1

Class V1_AsciiTable

Object

V1_AsciiTable

public final class V1_AsciiTable
extends Object

Original ASCII table with flexible column number, column width, wrapping, spanning and themes.

Since:

v0.0.1

Version:

v0.2.3 build 150910 (10-Sep-15) for Java 1.7

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Integer,String[][]>	table The actual table.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	V1_AsciiTable() Instantiates a table.

Method Summary

Modifier and Type	Method and Description
protected boolean	_init(Integer[] columns) Initialises columns.
protected boolean	_init(Integer columns, Integer width) Initializes columns.
int	addRow(Object... columns) Adds a new row to the table.
Integer[]	getColumnAr() Returns a clone of the column array.
int	getColumnCount() Returns the number of columns set for the table.
int	getWidth() Returns the width of the table.
static V1_AsciiTable	newTable(Integer[] columns) Returns a new instance of an ASCII Table.
static V1_AsciiTable	newTable(Integer columns, Integer width) Returns a new instance of an ASCII Table.
protected String[]	obj2At(Object obj, int colP) Returns a string array with wrapped lines.
String	render() Returns a rendered table using given options for rendering.
protected StrBuilder	renderBottomRule(String[][] row, char[] theme) Renders the bottom rule of the table.
protected StrBuilder	renderMiddleRule(String[][] top, String[][] bot, char[] theme) Renders a middle rule, that is a row separating two content rows.
protected StrBuilder	renderRow(String[][] row, char padChar, char[] theme) Renders rows of content with correct separators.
protected List<StrBuilder>	renderTable(char padChar, char[] theme) Renders the table.
protected StrBuilder	renderTopRule(String[][] row, char[] theme) Renders the top rule of the table.
V1_AsciiTable	setPaddingCharacter(char padChar) Sets the padding character, default is blank.
V1_AsciiTable	setTheme(V1_StandardTableThemes theme) Sets the rendering theme, default is plain 7 bit.
String	toString() Returns a string with debug information.

Methods inherited from class Object

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

Field Detail

table

protected Map<Integer,String[][]> table

The actual table. Each row is identified by an integer, count starts at 1. Columns are then linked lists of strings

Constructor Detail

V1_AsciiTable

protected V1_AsciiTable()

Instantiates a table. Use newTable(Integer[]) or newTable(Integer, Integer) to obtain an instance of the ASCII table.

Method Detail

newTable

public static V1_AsciiTable newTable(Integer columns,
                                     Integer width)

Returns a new instance of an ASCII Table. The available width will be evenly distributed over the number of columns. If space is left, the columns starting from 1 upwards will receive an extra character until the left space is consumed. The minimum width of a column is 3. This means that width must be at least (columns * 3 + columns + 1).

Parameters:

columns - number of columns for the table

width - maximum width of the table

Returns:

new instance or null in case the required width was insufficient for the number of columns

newTable

public static V1_AsciiTable newTable(Integer[] columns)

Returns a new instance of an ASCII Table. The actual width of the table is the sum of the width of all columns plus the characters needed to separate columns. The latter is calculated as (number of columns + 1). Each entry in the column array will be processed and <null> will be returned if the entry is <null> or if the requested width for a column is less than 3.

Parameters:

columns - array with information about the width of each column (entries of array) and number of columns (size of array)

Returns:

new instance or null if no columns given or a column was null or a column width was set to smaller than 3

setPaddingCharacter

public V1_AsciiTable setPaddingCharacter(char padChar)

Sets the padding character, default is blank.

Parameters:

padChar - new padding character

Returns:

self for chaining

setTheme

public V1_AsciiTable setTheme(V1_StandardTableThemes theme)

Sets the rendering theme, default is plain 7 bit.

Parameters:

theme - new theme

Returns:

self for chaining

addRow

public int addRow(Object... columns)

Adds a new row to the table. For each column of the set column size an object must be provided. This object can be <null>. It is also allowed that the object's toString() method returns null. The table row will later be build using this information in the following way:

• if the object for a column is null (or it's toString() method returns null), the column is assumed to be part of a column span. This span is calculated from the first column set to null up to the next column that is set to either empty ("") or some content (non-empty string). Column spans at the end of a row result in an empty row spanning all requested columns. For example, for a 3-column row with equal column-width of 4 characters (plus vertical separators)
  • (null, null, "text") will result in a row "|␣␣␣␣␣text␣␣␣␣␣|"
  • (null, "text", null) will result in a row "|␣␣text␣␣␣|␣␣␣␣|"
  • ("text", null, null) will result in a row "|text|␣␣␣␣␣␣␣␣␣|"
  • (null, null, null) will result in a row "|␣␣␣␣␣␣␣␣␣␣␣␣␣␣|"
• if the object's toString() method results in an empty string (""), the column will be padded with the padding character
• in any other cases the result of the object's toString() method is used as text for the column

Parameters:

columns - text for the columns

Returns:

-1 if table has no columns, 0 if given columns are 0 or if number of given columns is not the number of the set columns, index of the added row in all other cases

getColumnAr

public Integer[] getColumnAr()

Returns a clone of the column array.

Returns:

clone of the column array or null if not set

getColumnCount

public int getColumnCount()

Returns the number of columns set for the table.

Returns:

number of columns or null if no columns set

getWidth

public int getWidth()

Returns the width of the table.

Returns:

0 if no columns set, width of the table otherwise

_init

protected final boolean _init(Integer columns,
                              Integer width)

Initializes columns.

Parameters:

columns - number of columns

width - requested width of the table

Returns:

true if init was ok, false otherwise (no init done)

See Also:

newTable(Integer, Integer)

_init

protected final boolean _init(Integer[] columns)

Initialises columns.

Parameters:

columns - array with column width information (entries) and number of columns (array length)

Returns:

true if init was ok, false otherwise (no init done)

See Also:

newTable(Integer[])

obj2At

protected final String[] obj2At(Object obj,
                                int colP)

Returns a string array with wrapped lines.

Parameters:

obj - object containing a string (null and empty are allowed)

colP - index to the column array for column width

Returns:

null if object was null or toString() returns null, empty array if empty string, array with lines of wrappings otherwise

render

public String render()

Returns a rendered table using given options for rendering.

Returns:

rendered table

renderMiddleRule

protected final StrBuilder renderMiddleRule(String[][] top,
                                            String[][] bot,
                                            char[] theme)

Renders a middle rule, that is a row separating two content rows.

Parameters:

top - content row above the middle rule

bot - content row below the middle rule

theme - row theme

Returns:

line for the middle rule

renderBottomRule

protected final StrBuilder renderBottomRule(String[][] row,
                                            char[] theme)

Renders the bottom rule of the table.

Parameters:

row - last content row of the table

theme - row theme

Returns:

rendered bottom row

renderRow

protected final StrBuilder renderRow(String[][] row,
                                     char padChar,
                                     char[] theme)

Renders rows of content with correct separators.

Parameters:

row - array with all lines for all columns of a single row

padChar - padding character

theme - row theme

Returns:

rendered lines for the row, empty if nothing was to be rendered

renderTable

protected final List<StrBuilder> renderTable(char padChar,
                                             char[] theme)

Renders the table.

Parameters:

padChar - padding character

theme - row theme

Returns:

list of lines for the table, empty if nothing was there to be rendered

renderTopRule

protected final StrBuilder renderTopRule(String[][] row,
                                         char[] theme)

Renders the top rule of the table.

Parameters:

row - first content row of the table

theme - row theme

Returns:

rendered top row

toString

public String toString()

Returns a string with debug information.

Overrides:

toString in class Object

Returns:

string with debug information about the table