java/sql-dk/src/info/globalcode/sql/dk/formatting/TabularFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Fri, 27 Dec 2013 21:26:30 +0100
branchv_0
changeset 87 03bf24449c7a
parent 79 e19a13ed19a9
child 88 102ba0fcb07f
permissions -rw-r--r--
TabularFormatter: support for value trim (if longer than cell size)
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@34
    25
franta-hg@32
    26
/**
franta-hg@32
    27
 *
franta-hg@32
    28
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@32
    29
 */
franta-hg@32
    30
public class TabularFormatter extends AbstractFormatter {
franta-hg@32
    31
franta-hg@79
    32
	public static final String NAME = "tabular"; // bash-completion:formatter
franta-hg@39
    33
	private static final String HEADER_TYPE_PREFIX = " (";
franta-hg@39
    34
	private static final String HEADER_TYPE_SUFFIX = ")";
franta-hg@34
    35
	private ColorfulPrintWriter out;
franta-hg@37
    36
	private boolean firstResult = true;
franta-hg@39
    37
	private int[] columnWidth;
franta-hg@87
    38
	/**
franta-hg@87
    39
	 * use ASCII borders instead of unicode ones
franta-hg@87
    40
	 */
franta-hg@76
    41
	private final boolean asciiNostalgia = false;
franta-hg@87
    42
	/**
franta-hg@87
    43
	 * Trim values if they are longer than cell size
franta-hg@87
    44
	 */
franta-hg@87
    45
	private final boolean trimValues = false;
franta-hg@32
    46
franta-hg@32
    47
	public TabularFormatter(FormatterContext formatterContext) {
franta-hg@32
    48
		super(formatterContext);
franta-hg@34
    49
		out = new ColorfulPrintWriter(formatterContext.getOutputStream());
franta-hg@34
    50
	}
franta-hg@34
    51
franta-hg@34
    52
	@Override
franta-hg@37
    53
	public void writeStartResultSet() {
franta-hg@37
    54
		super.writeStartResultSet();
franta-hg@37
    55
		printResultSeparator();
franta-hg@37
    56
	}
franta-hg@37
    57
franta-hg@37
    58
	@Override
franta-hg@37
    59
	public void writeColumnsHeader(ColumnsHeader header) {
franta-hg@37
    60
		super.writeColumnsHeader(header);
franta-hg@37
    61
franta-hg@39
    62
		columnWidth = new int[header.getColumnCount()];
franta-hg@39
    63
franta-hg@40
    64
		printTableIndent();
franta-hg@40
    65
		printTableBorder("╭");
franta-hg@37
    66
		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
franta-hg@40
    67
			setColumnWidth(cd.getColumnNumber(), cd.getLabel().length() + cd.getTypeName().length() + HEADER_TYPE_PREFIX.length() + HEADER_TYPE_SUFFIX.length());
franta-hg@40
    68
			if (!cd.isFirstColumn()) {
franta-hg@40
    69
				printTableBorder("┬");
franta-hg@40
    70
			}
franta-hg@40
    71
			printTableBorder(repeat('─', getColumnWidth(cd.getColumnNumber()) + 2));
franta-hg@40
    72
		}
franta-hg@40
    73
		printTableBorder("╮");
franta-hg@40
    74
		out.println();
franta-hg@40
    75
franta-hg@40
    76
		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
franta-hg@40
    77
			if (cd.isFirstColumn()) {
franta-hg@40
    78
				printTableIndent();
franta-hg@40
    79
				printTableBorder("│ ");
franta-hg@40
    80
			} else {
franta-hg@40
    81
				printTableBorder(" │ ");
franta-hg@40
    82
			}
franta-hg@37
    83
			out.print(TerminalStyle.Bright, cd.getLabel());
franta-hg@39
    84
			out.print(HEADER_TYPE_PREFIX);
franta-hg@37
    85
			out.print(cd.getTypeName());
franta-hg@39
    86
			out.print(HEADER_TYPE_SUFFIX);
franta-hg@40
    87
			if (cd.isLastColumn()) {
franta-hg@40
    88
				printTableBorder(" │");
franta-hg@37
    89
			}
franta-hg@39
    90
franta-hg@39
    91
			setColumnWidth(cd.getColumnNumber(), cd.getLabel().length() + cd.getTypeName().length() + HEADER_TYPE_PREFIX.length() + HEADER_TYPE_SUFFIX.length());
franta-hg@37
    92
		}
franta-hg@37
    93
		out.println();
franta-hg@40
    94
franta-hg@40
    95
		printTableIndent();
franta-hg@40
    96
		printTableBorder("├");
franta-hg@40
    97
		for (int i = 1; i <= header.getColumnCount(); i++) {
franta-hg@40
    98
			if (i > 1) {
franta-hg@40
    99
				printTableBorder("┼");
franta-hg@40
   100
			}
franta-hg@40
   101
			printTableBorder(repeat('─', getColumnWidth(i) + 2));
franta-hg@40
   102
		}
franta-hg@40
   103
		printTableBorder("┤");
franta-hg@40
   104
		out.println();
franta-hg@40
   105
franta-hg@37
   106
		out.flush();
franta-hg@37
   107
	}
franta-hg@37
   108
franta-hg@37
   109
	@Override
franta-hg@34
   110
	public void writeColumnValue(Object value) {
franta-hg@34
   111
		super.writeColumnValue(value);
franta-hg@34
   112
franta-hg@40
   113
		if (isCurrentColumnFirst()) {
franta-hg@40
   114
			printTableIndent();
franta-hg@40
   115
			printTableBorder("│ ");
franta-hg@40
   116
		} else {
franta-hg@40
   117
			printTableBorder(" │ ");
franta-hg@34
   118
		}
franta-hg@37
   119
franta-hg@39
   120
		out.print(TerminalColor.Cyan, toString(value));
franta-hg@40
   121
franta-hg@40
   122
		if (isCurrentColumnLast()) {
franta-hg@40
   123
			printTableBorder(" │");
franta-hg@40
   124
		}
franta-hg@40
   125
franta-hg@39
   126
	}
franta-hg@39
   127
franta-hg@39
   128
	private int getColumnWidth(int columnNumber) {
franta-hg@39
   129
		return columnWidth[columnNumber - 1];
franta-hg@39
   130
	}
franta-hg@39
   131
franta-hg@39
   132
	private void setColumnWidth(int columnNumber, int width) {
franta-hg@39
   133
		columnWidth[columnNumber - 1] = width;
franta-hg@39
   134
	}
franta-hg@39
   135
franta-hg@39
   136
	private void updateColumnWidth(int columnNumber, int width) {
franta-hg@39
   137
		int oldWidth = getColumnWidth(columnNumber);
franta-hg@39
   138
		setColumnWidth(columnNumber, Math.max(width, oldWidth));
franta-hg@39
   139
franta-hg@39
   140
	}
franta-hg@39
   141
franta-hg@39
   142
	@Override
franta-hg@39
   143
	protected String toString(Object value) {
franta-hg@39
   144
		final int width = getColumnWidth(getCurrentColumnsCount());
franta-hg@87
   145
		String result;
franta-hg@43
   146
		if (value instanceof Number || value instanceof Boolean) {
franta-hg@87
   147
			result = lpad(super.toString(value), width);
franta-hg@39
   148
		} else {
franta-hg@87
   149
			result = rpad(super.toString(value), width);
franta-hg@39
   150
		}
franta-hg@40
   151
		// ?	value = (boolean) value ? "✔" : "✗";
franta-hg@87
   152
franta-hg@87
   153
		if (trimValues && result.length() > width) {
franta-hg@87
   154
			result = result.substring(0, width - 1) + "…";
franta-hg@87
   155
		}
franta-hg@87
   156
franta-hg@87
   157
		return result;
franta-hg@34
   158
	}
franta-hg@34
   159
franta-hg@34
   160
	@Override
franta-hg@34
   161
	public void writeEndRow() {
franta-hg@34
   162
		super.writeEndRow();
franta-hg@34
   163
		out.println();
franta-hg@34
   164
		out.flush();
franta-hg@32
   165
	}
franta-hg@37
   166
franta-hg@37
   167
	@Override
franta-hg@37
   168
	public void writeEndResultSet() {
franta-hg@40
   169
		int columnCount = getCurrentColumnsHeader().getColumnCount();
franta-hg@37
   170
		super.writeEndResultSet();
franta-hg@40
   171
franta-hg@40
   172
		printTableIndent();
franta-hg@40
   173
		printTableBorder("╰");
franta-hg@40
   174
		for (int i = 1; i <= columnCount; i++) {
franta-hg@40
   175
			if (i > 1) {
franta-hg@40
   176
				printTableBorder("┴");
franta-hg@40
   177
			}
franta-hg@40
   178
			printTableBorder(repeat('─', getColumnWidth(i) + 2));
franta-hg@40
   179
		}
franta-hg@40
   180
		printTableBorder("╯");
franta-hg@40
   181
		out.println();
franta-hg@40
   182
franta-hg@40
   183
franta-hg@37
   184
		out.print(TerminalColor.Yellow, "Record count: ");
franta-hg@37
   185
		out.println(getCurrentRowCount());
franta-hg@40
   186
		out.bell();
franta-hg@37
   187
		out.flush();
franta-hg@37
   188
	}
franta-hg@37
   189
franta-hg@37
   190
	@Override
franta-hg@37
   191
	public void writeStartUpdatesResult() {
franta-hg@37
   192
		super.writeStartUpdatesResult();
franta-hg@37
   193
		printResultSeparator();
franta-hg@37
   194
	}
franta-hg@37
   195
franta-hg@37
   196
	@Override
franta-hg@37
   197
	public void writeUpdatedRowsCount(int updatedRowsCount) {
franta-hg@37
   198
		super.writeUpdatedRowsCount(updatedRowsCount);
franta-hg@37
   199
		out.print(TerminalColor.Red, "Updated records: ");
franta-hg@37
   200
		out.println(updatedRowsCount);
franta-hg@40
   201
		out.bell();
franta-hg@37
   202
		out.flush();
franta-hg@37
   203
	}
franta-hg@37
   204
franta-hg@37
   205
	@Override
franta-hg@37
   206
	public void writeEndDatabase() {
franta-hg@37
   207
		super.writeEndDatabase();
franta-hg@37
   208
		out.flush();
franta-hg@37
   209
	}
franta-hg@37
   210
franta-hg@37
   211
	private void printResultSeparator() {
franta-hg@37
   212
		if (firstResult) {
franta-hg@37
   213
			firstResult = false;
franta-hg@37
   214
		} else {
franta-hg@37
   215
			out.println();
franta-hg@37
   216
		}
franta-hg@37
   217
	}
franta-hg@40
   218
franta-hg@40
   219
	private void printTableBorder(String border) {
franta-hg@76
   220
		if (asciiNostalgia) {
franta-hg@76
   221
			border = border.replaceAll("─", "-");
franta-hg@76
   222
			border = border.replaceAll("│", "|");
franta-hg@76
   223
			border = border.replaceAll("[╭┬╮├┼┤╰┴╯]", "+");
franta-hg@76
   224
		}
franta-hg@87
   225
franta-hg@40
   226
		out.print(TerminalColor.Green, border);
franta-hg@40
   227
	}
franta-hg@40
   228
franta-hg@40
   229
	private void printTableIndent() {
franta-hg@40
   230
		out.print(" ");
franta-hg@40
   231
	}
franta-hg@32
   232
}