TabularPrefetchingFormatter: prefetch whole result set to avoid value overflow the cell
3 * Copyright © 2013 František Kučera (frantovo.cz)
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package info.globalcode.sql.dk.formatting;
20 import info.globalcode.sql.dk.ColorfulPrintWriter;
21 import static info.globalcode.sql.dk.ColorfulPrintWriter.*;
22 import static info.globalcode.sql.dk.Functions.lpad;
23 import static info.globalcode.sql.dk.Functions.rpad;
24 import static info.globalcode.sql.dk.Functions.repeat;
25 import java.util.Arrays;
26 import java.util.List;
30 * @author Ing. František Kučera (frantovo.cz)
32 public class TabularFormatter extends AbstractFormatter {
34 public static final String NAME = "tabular"; // bash-completion:formatter
35 private static final String HEADER_TYPE_PREFIX = " (";
36 private static final String HEADER_TYPE_SUFFIX = ")";
37 private ColorfulPrintWriter out;
38 private boolean firstResult = true;
39 private int[] columnWidth;
41 * use ASCII borders instead of unicode ones
43 private final boolean asciiNostalgia = false;
45 * Trim values if they are longer than cell size
47 private final boolean trimValues = false;
49 public TabularFormatter(FormatterContext formatterContext) {
50 super(formatterContext);
51 out = new ColorfulPrintWriter(formatterContext.getOutputStream());
55 public void writeStartResultSet() {
56 super.writeStartResultSet();
57 printResultSeparator();
61 public void writeColumnsHeader(ColumnsHeader header) {
62 super.writeColumnsHeader(header);
64 initColumnWidths(header.getColumnCount());
67 printTableBorder("╭");
69 List<ColumnDescriptor> columnDescriptors = header.getColumnDescriptors();
71 for (ColumnDescriptor cd : columnDescriptors) {
72 // padding: make header cell at least same width as data cells in this column
73 int typeWidth = cd.getTypeName().length() + HEADER_TYPE_PREFIX.length() + HEADER_TYPE_SUFFIX.length();
74 cd.setLabel(rpad(cd.getLabel(), getColumnWidth(cd.getColumnNumber()) - typeWidth));
75 updateColumnWidth(cd.getColumnNumber(), cd.getLabel().length() + typeWidth);
77 if (!cd.isFirstColumn()) {
78 printTableBorder("┬");
80 printTableBorder(repeat('─', getColumnWidth(cd.getColumnNumber()) + 2));
82 printTableBorder("╮");
85 for (ColumnDescriptor cd : columnDescriptors) {
86 if (cd.isFirstColumn()) {
88 printTableBorder("│ ");
90 printTableBorder(" │ ");
92 out.print(TerminalStyle.Bright, cd.getLabel());
93 out.print(HEADER_TYPE_PREFIX);
94 out.print(cd.getTypeName());
95 out.print(HEADER_TYPE_SUFFIX);
96 if (cd.isLastColumn()) {
97 printTableBorder(" │");
103 printTableBorder("├");
104 for (int i = 1; i <= header.getColumnCount(); i++) {
106 printTableBorder("┼");
108 printTableBorder(repeat('─', getColumnWidth(i) + 2));
110 printTableBorder("┤");
117 * Must be called before
118 * {@linkplain #updateColumnWidth(int, int)}
119 * and {@linkplain #getColumnWidth(int)}
120 * for each result set.
122 * @param columnCount number of columns in current result set
124 protected void initColumnWidths(int columnCount) {
125 if (columnWidth == null) {
126 columnWidth = new int[columnCount];
130 protected void cleanColumnWidths() {
135 public void writeColumnValue(Object value) {
136 super.writeColumnValue(value);
138 if (isCurrentColumnFirst()) {
140 printTableBorder("│ ");
142 printTableBorder(" │ ");
145 out.print(TerminalColor.Cyan, toString(value));
147 if (isCurrentColumnLast()) {
148 printTableBorder(" │");
153 private int getColumnWidth(int columnNumber) {
154 return columnWidth[columnNumber - 1];
157 private void setColumnWidth(int columnNumber, int width) {
158 columnWidth[columnNumber - 1] = width;
161 protected void updateColumnWidth(int columnNumber, int width) {
162 int oldWidth = getColumnWidth(columnNumber);
163 setColumnWidth(columnNumber, Math.max(width, oldWidth));
168 protected String toString(Object value) {
169 final int width = getColumnWidth(getCurrentColumnsCount());
171 if (value instanceof Number || value instanceof Boolean) {
172 result = lpad(super.toString(value), width);
174 result = rpad(super.toString(value), width);
176 // ? value = (boolean) value ? "✔" : "✗";
178 if (trimValues && result.length() > width) {
179 result = result.substring(0, width - 1) + "…";
186 public void writeEndRow() {
193 public void writeEndResultSet() {
194 int columnCount = getCurrentColumnsHeader().getColumnCount();
195 super.writeEndResultSet();
198 printTableBorder("╰");
199 for (int i = 1; i <= columnCount; i++) {
201 printTableBorder("┴");
203 printTableBorder(repeat('─', getColumnWidth(i) + 2));
205 printTableBorder("╯");
210 out.print(TerminalColor.Yellow, "Record count: ");
211 out.println(getCurrentRowCount());
217 public void writeStartUpdatesResult() {
218 super.writeStartUpdatesResult();
219 printResultSeparator();
223 public void writeUpdatedRowsCount(int updatedRowsCount) {
224 super.writeUpdatedRowsCount(updatedRowsCount);
225 out.print(TerminalColor.Red, "Updated records: ");
226 out.println(updatedRowsCount);
232 public void writeEndDatabase() {
233 super.writeEndDatabase();
237 private void printResultSeparator() {
245 private void printTableBorder(String border) {
246 if (asciiNostalgia) {
247 border = border.replaceAll("─", "-");
248 border = border.replaceAll("│", "|");
249 border = border.replaceAll("[╭┬╮├┼┤╰┴╯]", "+");
252 out.print(TerminalColor.Green, border);
255 private void printTableIndent() {