org.nocrala.tools.texttablefmt.Table Maven / Gradle / Ivy
The newest version!
package org.nocrala.tools.texttablefmt;
import java.util.ArrayList;
import java.util.List;
import org.apache.log4j.Logger;
/**
* In-memory text table generator. This class will generate text tables
* like:
*
*
*
* +---------+-----------+----------+--------+
* |Country | Population|Area (km2)| Density|
* +---------+-----------+----------+--------+
* |Chile | 17 000 000| 1 250 000| 13.60|
* |Argentina| 50 000 000| 3 000 000| 16.67|
* |Brasil | 80 000 000| 5 000 000| 16.00|
* +---------+-----------+----------+--------+
* |Total |147 000 000| 9 250 000| 15.89|
* +---------+-----------+----------+--------+
*
*
* where the border style, shown borders/separators, column
* widths, alignments and other are configurable.
*
* Cells are added using the addCell() method and finally
* rendered as a String using the render() method.
*
* The entire table is built in memory, so this class is not intended for a massive
* numbers of rows/cells. Although the maximum size of the in-memory table depends on
* the amount of available memory the JVM has, as a rule of thumb, don't exceed
* 10.000 total cells. If you need to render a bigger table, use the
* StreamingTable class instead.
*
* If no widths are specified for a column, its width will adjusted to the
* wider cell in the column.
*
* As an example, the following code:
*
*
*
* CellStyle cs = new CellStyle(HorizontalAlign.left, AbbreviationStyle.crop,
* NullStyle.emptyString);
* Table t = new Table(2, BorderStyle.CLASSIC, ShownBorders.ALL, false, "");
* t.addCell("abcdef", cs);
* t.addCell("123456", cs);
* t.addCell("mno", cs);
* t.addCell("45689", cs);
* t.addCell("xyztuvw", cs);
* t.addCell("01234567", cs);
* System.out.println(t.render());
*
*
* will generate the table:
*
*
*
* +-------+--------+
* |abcdef |123456 |
* +-------+--------+
* |mno |45689 |
* +-------+--------+
* |xyztuvw|01234567|
* +-------+--------+
*
*
* The generated table can be customized using a BorderStyle,
* ShownBorders and cell widths. Besides, cell rendering can be
* customized on a cell basis using CellStyles.
*
* @author valarcon
*
*/
public class Table {
private static Logger logger = Logger.getLogger(Table.class);
private static final int DEFAULT_MIN_WIDTH = 0;
private static final int DEFAULT_MAX_WIDTH = Integer.MAX_VALUE;
TableStyle tableStyle;
private List rows;
private List columns;
private int totalColumns;
private int currentColumn;
private Row currentRow;
/**
* Creates a table using BorderStyle.CLASSIC and
* ShownBorders.SURROUND_HEADER_AND_COLUMNS, no XML
* escaping and no left margin.
*
* @param totalColumns Total columns of this table.
*/
public Table(final int totalColumns) {
initialize(totalColumns);
this.tableStyle = new TableStyle(BorderStyle.CLASSIC,
ShownBorders.SURROUND_HEADER_AND_COLUMNS, false, 0, null);
}
/**
* Creates a table using the specified border style and
* ShownBorders.SURROUND_HEADER_AND_COLUMNS, no XML
* escaping and no left margin.
*
* @param totalColumns Total columns of this table.
* @param borderStyle The border style to use when rendering the table.
*/
public Table(final int totalColumns, final BorderStyle borderStyle) {
initialize(totalColumns);
this.tableStyle = new TableStyle(borderStyle,
ShownBorders.SURROUND_HEADER_AND_COLUMNS, false, 0, null);
}
/**
* Creates a table using the specified border style and shown borders,
* with no XML escaping and no left margin.
*
* @param totalColumns Total columns of this table.
* @param borderStyle The border style to use when rendering the table.
* @param shownBorders Specifies which borders will be rendered.
*/
public Table(final int totalColumns, final BorderStyle borderStyle,
final ShownBorders shownBorders) {
initialize(totalColumns);
this.tableStyle = new TableStyle(borderStyle, shownBorders, false, 0, null);
}
/**
* Creates a table using the specified border style and shown borders,
* XML escaping and no left margin.
*
* @param totalColumns Total columns of this table.
* @param borderStyle The border style to use when rendering the table.
* @param shownBorders Specifies which borders will be rendered.
* @param escapeXml Specifies if the rendered text should be escaped using
* XML entities.
*/
public Table(final int totalColumns, final BorderStyle borderStyle,
final ShownBorders shownBorders, final boolean escapeXml) {
initialize(totalColumns);
this.tableStyle = new TableStyle(borderStyle, shownBorders, escapeXml, 0,
null);
}
/**
* Creates a table using the specified border style and shown borders,
* XML escaping and left margin.
*
* @param totalColumns Total columns of this table.
* @param borderStyle The border style to use when rendering the table.
* @param shownBorders Specifies which borders will be rendered.
* @param escapeXml Specifies if the rendered text should be escaped using
* XML entities.
* @param leftMargin Specifies how many blank spaces to use as a left margin for the table.
*/
public Table(final int totalColumns, final BorderStyle borderStyle,
final ShownBorders shownBorders, final boolean escapeXml,
final int leftMargin) {
initialize(totalColumns);
this.tableStyle = new TableStyle(borderStyle, shownBorders, escapeXml,
leftMargin, null);
}
/**
* Creates a table using the specified border style and shown borders,
* XML escaping and left margin.
*
* @param totalColumns Total columns of this table.
* @param borderStyle The border style to use when rendering the table.
* @param shownBorders Specifies which borders will be rendered.
* @param escapeXml Specifies if the rendered text should be escaped using
* XML entities.
* @param prompt Text to use as left margin for the table.
*/
public Table(final int totalColumns, final BorderStyle borderStyle,
final ShownBorders shownBorders, final boolean escapeXml,
final String prompt) {
initialize(totalColumns);
this.tableStyle = new TableStyle(borderStyle, shownBorders, escapeXml, 0,
prompt);
}
private void initialize(final int totalColumns) {
this.totalColumns = totalColumns;
this.rows = new ArrayList();
this.columns = new ArrayList();
for (int i = 0; i < this.totalColumns; i++) {
this.columns.add(new Column(i, DEFAULT_MIN_WIDTH, DEFAULT_MAX_WIDTH));
}
this.currentColumn = 0;
this.currentRow = null;
}
/**
* Sets the minimum and maximum desired column widths of a specific column. If
* no width range is specified for a column, its width will be adjusted to the
* wider cell in the column.
*
* @param col Column whose desired widths will be set. First column is 0
* (zero).
* @param minWidth Minimum desired width.
* @param maxWidth Maximum desired width.
*/
public void setColumnWidth(final int col, final int minWidth,
final int maxWidth) {
this.columns.get(col).setWidthRange(minWidth, maxWidth);
}
/**
* Adds a cell with the default CellStyle. See CellStyle for details
* on its default characteristics.
*
* @param content Cell text.
*/
public void addCell(final String content) {
addCell(content, new CellStyle());
}
/**
* Adds a cell with a colspan and the default CellStyle.
*
* @param content Cell text.
* @param colSpan Columns this cell will span through.
*/
public void addCell(final String content, final int colSpan) {
addCell(content, new CellStyle(), colSpan);
}
/**
* Adds a cell with a specific cell style.
*
* @param content Cell text.
* @param style Cell style to use when rendering the cell content.
*/
public void addCell(final String content, final CellStyle style) {
addCell(content, style, 1);
}
/**
* Adds a cell with a specific cell style and colspan.
*
* @param content Cell text.
* @param style Cell style to use when rendering the cell content.
* @param colSpan Columns this cell will span through.
*/
public void addCell(final String content, final CellStyle style,
final int colSpan) {
if (this.currentRow == null || this.currentColumn >= this.totalColumns) {
this.currentRow = new Row();
this.rows.add(currentRow);
this.currentColumn = 0;
}
int adjColSpan = colSpan > 0 ? colSpan : 1;
if (this.currentColumn + adjColSpan > this.totalColumns) {
adjColSpan = this.totalColumns - this.currentColumn;
}
this.currentRow.addCell(content, style, adjColSpan);
this.currentColumn = this.currentColumn + adjColSpan;
}
/**
* Renders the table as a multi-line String.
*
* @return rendered table.
*/
public String render() {
calculateColumnsWidth();
return this.tableStyle.renderTable(this);
}
/**
* Renders the table as a String array.
*
* @return rendered table
*/
public String[] renderAsStringArray() {
calculateColumnsWidth();
return this.tableStyle.renderAsStringArray(this);
}
int getTotalColumns() {
return this.totalColumns;
}
private void calculateColumnsWidth() {
// First we connect the columns with the cells.
for (Row r : this.rows) {
int startCol = 0;
for (Cell cell : r.getCells()) {
int endCol = startCol + cell.getColSpan() - 1;
try {
Column col = this.columns.get(endCol);
col.add(cell);
startCol = startCol + cell.getColSpan();
} catch (IndexOutOfBoundsException e) {
// Nothing to do.
}
}
}
// Then we calculate the appropriate column width for each one.
for (Column col : this.columns) {
col.calculateWidth(this.columns, this.tableStyle.borderStyle
.getTCCorner().length());
logger.debug("width=" + col.getColumnWidth());
}
}
List getRows() {
return this.rows;
}
List getColumns() {
return this.columns;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy