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