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.List;
29 * @author Ing. František Kučera (frantovo.cz)
31 public class TabularFormatter extends AbstractFormatter {
33 public static final String NAME = "tabular"; // bash-completion:formatter
34 private static final String HEADER_TYPE_PREFIX = " (";
35 private static final String HEADER_TYPE_SUFFIX = ")";
36 private ColorfulPrintWriter out;
37 private boolean firstResult = true;
38 private int[] columnWidth;
40 * use ASCII borders instead of unicode ones
42 private final boolean asciiNostalgia = false;
44 * Trim values if they are longer than cell size
46 private final boolean trimValues = false;
48 public TabularFormatter(FormatterContext formatterContext) {
49 super(formatterContext);
50 out = new ColorfulPrintWriter(formatterContext.getOutputStream());
54 public void writeStartResultSet() {
55 super.writeStartResultSet();
56 printResultSeparator();
60 public void writeColumnsHeader(ColumnsHeader header) {
61 super.writeColumnsHeader(header);
63 initColumnWidths(header.getColumnCount());
66 printTableBorder("╭");
68 List<ColumnDescriptor> columnDescriptors = header.getColumnDescriptors();
70 for (ColumnDescriptor cd : columnDescriptors) {
71 // padding: make header cell at least same width as data cells in this column
72 int typeWidth = cd.getTypeName().length() + HEADER_TYPE_PREFIX.length() + HEADER_TYPE_SUFFIX.length();
73 cd.setLabel(rpad(cd.getLabel(), getColumnWidth(cd.getColumnNumber()) - typeWidth));
74 updateColumnWidth(cd.getColumnNumber(), cd.getLabel().length() + typeWidth);
76 if (!cd.isFirstColumn()) {
77 printTableBorder("┬");
79 printTableBorder(repeat('─', getColumnWidth(cd.getColumnNumber()) + 2));
81 printTableBorder("╮");
84 for (ColumnDescriptor cd : columnDescriptors) {
85 if (cd.isFirstColumn()) {
87 printTableBorder("│ ");
89 printTableBorder(" │ ");
91 out.print(TerminalStyle.Bright, cd.getLabel());
92 out.print(HEADER_TYPE_PREFIX);
93 out.print(cd.getTypeName());
94 out.print(HEADER_TYPE_SUFFIX);
95 if (cd.isLastColumn()) {
96 printTableBorder(" │");
102 printTableBorder("├");
103 for (int i = 1; i <= header.getColumnCount(); i++) {
105 printTableBorder("┼");
107 printTableBorder(repeat('─', getColumnWidth(i) + 2));
109 printTableBorder("┤");
116 * Must be called before
117 * {@linkplain #updateColumnWidth(int, int)}
118 * and {@linkplain #getColumnWidth(int)}
119 * for each result set.
121 * @param columnCount number of columns in current result set
123 protected void initColumnWidths(int columnCount) {
124 if (columnWidth == null) {
125 columnWidth = new int[columnCount];
129 protected void cleanColumnWidths() {
134 public void writeColumnValue(Object value) {
135 super.writeColumnValue(value);
137 if (isCurrentColumnFirst()) {
139 printTableBorder("│ ");
141 printTableBorder(" │ ");
144 String[] valueParts = toString(value).split("\n");
145 for (int i = 0; i < valueParts.length; i++) {
146 String valuePart = valueParts[i];
147 out.print(TerminalColor.Cyan, valuePart);
148 if (i < valueParts.length - 1) {
149 out.print(TerminalColor.Red, "↲");
153 if (isCurrentColumnLast()) {
154 printTableBorder(" │");
159 private int getColumnWidth(int columnNumber) {
160 return columnWidth[columnNumber - 1];
163 private void setColumnWidth(int columnNumber, int width) {
164 columnWidth[columnNumber - 1] = width;
167 protected void updateColumnWidth(int columnNumber, int width) {
168 int oldWidth = getColumnWidth(columnNumber);
169 setColumnWidth(columnNumber, Math.max(width, oldWidth));
173 protected String toString(Object value) {
174 final int width = getColumnWidth(getCurrentColumnsCount());
176 if (value instanceof Number || value instanceof Boolean) {
177 result = lpad(String.valueOf(value), width);
179 result = rpad(String.valueOf(value), width);
181 // ? value = (boolean) value ? "✔" : "✗";
183 if (trimValues && result.length() > width) {
184 result = result.substring(0, width - 1) + "…";
191 public void writeEndRow() {
198 public void writeEndResultSet() {
199 int columnCount = getCurrentColumnsHeader().getColumnCount();
200 super.writeEndResultSet();
203 printTableBorder("╰");
204 for (int i = 1; i <= columnCount; i++) {
206 printTableBorder("┴");
208 printTableBorder(repeat('─', getColumnWidth(i) + 2));
210 printTableBorder("╯");
215 out.print(TerminalColor.Yellow, "Record count: ");
216 out.println(getCurrentRowCount());
222 public void writeStartUpdatesResult() {
223 super.writeStartUpdatesResult();
224 printResultSeparator();
228 public void writeUpdatedRowsCount(int updatedRowsCount) {
229 super.writeUpdatedRowsCount(updatedRowsCount);
230 out.print(TerminalColor.Red, "Updated records: ");
231 out.println(updatedRowsCount);
237 public void writeEndDatabase() {
238 super.writeEndDatabase();
242 private void printResultSeparator() {
250 private void printTableBorder(String border) {
251 if (asciiNostalgia) {
252 border = border.replaceAll("─", "-");
253 border = border.replaceAll("│", "|");
254 border = border.replaceAll("[╭┬╮├┼┤╰┴╯]", "+");
257 out.print(TerminalColor.Green, border);
260 private void printTableIndent() {