java/sql-dk/src/info/globalcode/sql/dk/formatting/TabularFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Mon, 30 Dec 2013 23:46:41 +0100
branchv_0
changeset 103 5410b6afc839
parent 98 4d420f8b3320
child 104 245f1b88a3e6
permissions -rw-r--r--
TabularFormatter: values with line ends will not break our tables
franta-hg@32
     1
/**
franta-hg@32
     2
 * SQL-DK
franta-hg@32
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@32
     4
 *
franta-hg@32
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@32
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@32
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@32
     8
 * (at your option) any later version.
franta-hg@32
     9
 *
franta-hg@32
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@32
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@32
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@32
    13
 * GNU General Public License for more details.
franta-hg@32
    14
 *
franta-hg@32
    15
 * You should have received a copy of the GNU General Public License
franta-hg@32
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@32
    17
 */
franta-hg@32
    18
package info.globalcode.sql.dk.formatting;
franta-hg@32
    19
franta-hg@34
    20
import info.globalcode.sql.dk.ColorfulPrintWriter;
franta-hg@37
    21
import static info.globalcode.sql.dk.ColorfulPrintWriter.*;
franta-hg@39
    22
import static info.globalcode.sql.dk.Functions.lpad;
franta-hg@39
    23
import static info.globalcode.sql.dk.Functions.rpad;
franta-hg@40
    24
import static info.globalcode.sql.dk.Functions.repeat;
franta-hg@88
    25
import java.util.List;
franta-hg@34
    26
franta-hg@32
    27
/**
franta-hg@32
    28
 *
franta-hg@32
    29
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@32
    30
 */
franta-hg@32
    31
public class TabularFormatter extends AbstractFormatter {
franta-hg@32
    32
franta-hg@79
    33
	public static final String NAME = "tabular"; // bash-completion:formatter
franta-hg@39
    34
	private static final String HEADER_TYPE_PREFIX = " (";
franta-hg@39
    35
	private static final String HEADER_TYPE_SUFFIX = ")";
franta-hg@34
    36
	private ColorfulPrintWriter out;
franta-hg@37
    37
	private boolean firstResult = true;
franta-hg@39
    38
	private int[] columnWidth;
franta-hg@87
    39
	/**
franta-hg@87
    40
	 * use ASCII borders instead of unicode ones
franta-hg@87
    41
	 */
franta-hg@76
    42
	private final boolean asciiNostalgia = false;
franta-hg@87
    43
	/**
franta-hg@87
    44
	 * Trim values if they are longer than cell size
franta-hg@87
    45
	 */
franta-hg@87
    46
	private final boolean trimValues = false;
franta-hg@32
    47
franta-hg@32
    48
	public TabularFormatter(FormatterContext formatterContext) {
franta-hg@32
    49
		super(formatterContext);
franta-hg@34
    50
		out = new ColorfulPrintWriter(formatterContext.getOutputStream());
franta-hg@34
    51
	}
franta-hg@34
    52
franta-hg@34
    53
	@Override
franta-hg@37
    54
	public void writeStartResultSet() {
franta-hg@37
    55
		super.writeStartResultSet();
franta-hg@37
    56
		printResultSeparator();
franta-hg@37
    57
	}
franta-hg@37
    58
franta-hg@37
    59
	@Override
franta-hg@37
    60
	public void writeColumnsHeader(ColumnsHeader header) {
franta-hg@37
    61
		super.writeColumnsHeader(header);
franta-hg@37
    62
franta-hg@88
    63
		initColumnWidths(header.getColumnCount());
franta-hg@39
    64
franta-hg@40
    65
		printTableIndent();
franta-hg@40
    66
		printTableBorder("╭");
franta-hg@88
    67
franta-hg@88
    68
		List<ColumnDescriptor> columnDescriptors = header.getColumnDescriptors();
franta-hg@88
    69
franta-hg@88
    70
		for (ColumnDescriptor cd : columnDescriptors) {
franta-hg@88
    71
			// padding: make header cell at least same width as data cells in this column
franta-hg@88
    72
			int typeWidth = cd.getTypeName().length() + HEADER_TYPE_PREFIX.length() + HEADER_TYPE_SUFFIX.length();
franta-hg@88
    73
			cd.setLabel(rpad(cd.getLabel(), getColumnWidth(cd.getColumnNumber()) - typeWidth));
franta-hg@88
    74
			updateColumnWidth(cd.getColumnNumber(), cd.getLabel().length() + typeWidth);
franta-hg@88
    75
franta-hg@40
    76
			if (!cd.isFirstColumn()) {
franta-hg@40
    77
				printTableBorder("┬");
franta-hg@40
    78
			}
franta-hg@40
    79
			printTableBorder(repeat('─', getColumnWidth(cd.getColumnNumber()) + 2));
franta-hg@40
    80
		}
franta-hg@40
    81
		printTableBorder("╮");
franta-hg@40
    82
		out.println();
franta-hg@40
    83
franta-hg@88
    84
		for (ColumnDescriptor cd : columnDescriptors) {
franta-hg@40
    85
			if (cd.isFirstColumn()) {
franta-hg@40
    86
				printTableIndent();
franta-hg@40
    87
				printTableBorder("│ ");
franta-hg@40
    88
			} else {
franta-hg@40
    89
				printTableBorder(" │ ");
franta-hg@40
    90
			}
franta-hg@37
    91
			out.print(TerminalStyle.Bright, cd.getLabel());
franta-hg@39
    92
			out.print(HEADER_TYPE_PREFIX);
franta-hg@37
    93
			out.print(cd.getTypeName());
franta-hg@39
    94
			out.print(HEADER_TYPE_SUFFIX);
franta-hg@40
    95
			if (cd.isLastColumn()) {
franta-hg@40
    96
				printTableBorder(" │");
franta-hg@37
    97
			}
franta-hg@37
    98
		}
franta-hg@37
    99
		out.println();
franta-hg@40
   100
franta-hg@40
   101
		printTableIndent();
franta-hg@40
   102
		printTableBorder("├");
franta-hg@40
   103
		for (int i = 1; i <= header.getColumnCount(); i++) {
franta-hg@40
   104
			if (i > 1) {
franta-hg@40
   105
				printTableBorder("┼");
franta-hg@40
   106
			}
franta-hg@40
   107
			printTableBorder(repeat('─', getColumnWidth(i) + 2));
franta-hg@40
   108
		}
franta-hg@40
   109
		printTableBorder("┤");
franta-hg@40
   110
		out.println();
franta-hg@40
   111
franta-hg@37
   112
		out.flush();
franta-hg@37
   113
	}
franta-hg@37
   114
franta-hg@88
   115
	/**
franta-hg@88
   116
	 * Must be called before
franta-hg@88
   117
	 * {@linkplain #updateColumnWidth(int, int)}
franta-hg@88
   118
	 * and {@linkplain #getColumnWidth(int)}
franta-hg@88
   119
	 * for each result set.
franta-hg@88
   120
	 *
franta-hg@88
   121
	 * @param columnCount number of columns in current result set
franta-hg@88
   122
	 */
franta-hg@88
   123
	protected void initColumnWidths(int columnCount) {
franta-hg@88
   124
		if (columnWidth == null) {
franta-hg@88
   125
			columnWidth = new int[columnCount];
franta-hg@88
   126
		}
franta-hg@88
   127
	}
franta-hg@88
   128
franta-hg@88
   129
	protected void cleanColumnWidths() {
franta-hg@88
   130
		columnWidth = null;
franta-hg@88
   131
	}
franta-hg@88
   132
franta-hg@37
   133
	@Override
franta-hg@34
   134
	public void writeColumnValue(Object value) {
franta-hg@34
   135
		super.writeColumnValue(value);
franta-hg@34
   136
franta-hg@40
   137
		if (isCurrentColumnFirst()) {
franta-hg@40
   138
			printTableIndent();
franta-hg@40
   139
			printTableBorder("│ ");
franta-hg@40
   140
		} else {
franta-hg@90
   141
			printTableBorder(" │ ");
franta-hg@34
   142
		}
franta-hg@37
   143
franta-hg@103
   144
		String[] valueParts = toString(value).split("\n");
franta-hg@103
   145
		for (int i = 0; i < valueParts.length; i++) {
franta-hg@103
   146
			String valuePart = valueParts[i];
franta-hg@103
   147
			out.print(TerminalColor.Cyan, valuePart);
franta-hg@103
   148
			if (i < valueParts.length - 1) {
franta-hg@103
   149
				out.print(TerminalColor.Red, "↲");
franta-hg@103
   150
			}
franta-hg@103
   151
		}
franta-hg@40
   152
franta-hg@40
   153
		if (isCurrentColumnLast()) {
franta-hg@90
   154
			printTableBorder(" │");
franta-hg@40
   155
		}
franta-hg@40
   156
franta-hg@39
   157
	}
franta-hg@39
   158
franta-hg@39
   159
	private int getColumnWidth(int columnNumber) {
franta-hg@39
   160
		return columnWidth[columnNumber - 1];
franta-hg@39
   161
	}
franta-hg@39
   162
franta-hg@39
   163
	private void setColumnWidth(int columnNumber, int width) {
franta-hg@39
   164
		columnWidth[columnNumber - 1] = width;
franta-hg@39
   165
	}
franta-hg@39
   166
franta-hg@88
   167
	protected void updateColumnWidth(int columnNumber, int width) {
franta-hg@39
   168
		int oldWidth = getColumnWidth(columnNumber);
franta-hg@39
   169
		setColumnWidth(columnNumber, Math.max(width, oldWidth));
franta-hg@39
   170
franta-hg@39
   171
	}
franta-hg@39
   172
franta-hg@39
   173
	protected String toString(Object value) {
franta-hg@39
   174
		final int width = getColumnWidth(getCurrentColumnsCount());
franta-hg@87
   175
		String result;
franta-hg@43
   176
		if (value instanceof Number || value instanceof Boolean) {
franta-hg@98
   177
			result = lpad(String.valueOf(value), width);
franta-hg@39
   178
		} else {
franta-hg@98
   179
			result = rpad(String.valueOf(value), width);
franta-hg@39
   180
		}
franta-hg@40
   181
		// ?	value = (boolean) value ? "✔" : "✗";
franta-hg@87
   182
franta-hg@87
   183
		if (trimValues && result.length() > width) {
franta-hg@87
   184
			result = result.substring(0, width - 1) + "…";
franta-hg@87
   185
		}
franta-hg@87
   186
franta-hg@87
   187
		return result;
franta-hg@34
   188
	}
franta-hg@34
   189
franta-hg@34
   190
	@Override
franta-hg@34
   191
	public void writeEndRow() {
franta-hg@34
   192
		super.writeEndRow();
franta-hg@34
   193
		out.println();
franta-hg@34
   194
		out.flush();
franta-hg@32
   195
	}
franta-hg@37
   196
franta-hg@37
   197
	@Override
franta-hg@37
   198
	public void writeEndResultSet() {
franta-hg@40
   199
		int columnCount = getCurrentColumnsHeader().getColumnCount();
franta-hg@37
   200
		super.writeEndResultSet();
franta-hg@40
   201
franta-hg@40
   202
		printTableIndent();
franta-hg@40
   203
		printTableBorder("╰");
franta-hg@40
   204
		for (int i = 1; i <= columnCount; i++) {
franta-hg@40
   205
			if (i > 1) {
franta-hg@40
   206
				printTableBorder("┴");
franta-hg@40
   207
			}
franta-hg@40
   208
			printTableBorder(repeat('─', getColumnWidth(i) + 2));
franta-hg@40
   209
		}
franta-hg@40
   210
		printTableBorder("╯");
franta-hg@40
   211
		out.println();
franta-hg@40
   212
franta-hg@88
   213
		cleanColumnWidths();
franta-hg@40
   214
franta-hg@37
   215
		out.print(TerminalColor.Yellow, "Record count: ");
franta-hg@37
   216
		out.println(getCurrentRowCount());
franta-hg@40
   217
		out.bell();
franta-hg@37
   218
		out.flush();
franta-hg@37
   219
	}
franta-hg@37
   220
franta-hg@37
   221
	@Override
franta-hg@37
   222
	public void writeStartUpdatesResult() {
franta-hg@37
   223
		super.writeStartUpdatesResult();
franta-hg@37
   224
		printResultSeparator();
franta-hg@37
   225
	}
franta-hg@37
   226
franta-hg@37
   227
	@Override
franta-hg@37
   228
	public void writeUpdatedRowsCount(int updatedRowsCount) {
franta-hg@37
   229
		super.writeUpdatedRowsCount(updatedRowsCount);
franta-hg@37
   230
		out.print(TerminalColor.Red, "Updated records: ");
franta-hg@37
   231
		out.println(updatedRowsCount);
franta-hg@40
   232
		out.bell();
franta-hg@37
   233
		out.flush();
franta-hg@37
   234
	}
franta-hg@37
   235
franta-hg@37
   236
	@Override
franta-hg@37
   237
	public void writeEndDatabase() {
franta-hg@37
   238
		super.writeEndDatabase();
franta-hg@37
   239
		out.flush();
franta-hg@37
   240
	}
franta-hg@37
   241
franta-hg@37
   242
	private void printResultSeparator() {
franta-hg@37
   243
		if (firstResult) {
franta-hg@37
   244
			firstResult = false;
franta-hg@37
   245
		} else {
franta-hg@37
   246
			out.println();
franta-hg@37
   247
		}
franta-hg@37
   248
	}
franta-hg@40
   249
franta-hg@40
   250
	private void printTableBorder(String border) {
franta-hg@76
   251
		if (asciiNostalgia) {
franta-hg@76
   252
			border = border.replaceAll("─", "-");
franta-hg@76
   253
			border = border.replaceAll("│", "|");
franta-hg@76
   254
			border = border.replaceAll("[╭┬╮├┼┤╰┴╯]", "+");
franta-hg@76
   255
		}
franta-hg@87
   256
franta-hg@40
   257
		out.print(TerminalColor.Green, border);
franta-hg@40
   258
	}
franta-hg@40
   259
franta-hg@40
   260
	private void printTableIndent() {
franta-hg@40
   261
		out.print(" ");
franta-hg@40
   262
	}
franta-hg@32
   263
}