java/sql-dk/src/main/java/info/globalcode/sql/dk/formatting/TabularWrappingFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Thu, 24 Oct 2019 21:43:08 +0200
branchv_0
changeset 250 aae5009bd0af
parent 238 4a1864c3e867
permissions -rw-r--r--
fix license version: GNU GPLv3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
123
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     1
/**
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     2
 * SQL-DK
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     3
 * Copyright © 2014 František Kučera (frantovo.cz)
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     4
 *
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     5
 * This program is free software: you can redistribute it and/or modify
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License as published by
250
aae5009bd0af fix license version: GNU GPLv3
František Kučera <franta-hg@frantovo.cz>
parents: 238
diff changeset
     7
 * the Free Software Foundation, version 3 of the License.
123
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     8
 *
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    12
 * GNU General Public License for more details.
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    13
 *
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    15
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    16
 */
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    17
package info.globalcode.sql.dk.formatting;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    18
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    19
import info.globalcode.sql.dk.ColorfulPrintWriter.TerminalColor;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    20
import java.util.ArrayList;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    21
import java.util.List;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    22
import static info.globalcode.sql.dk.Functions.lpad;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    23
import static info.globalcode.sql.dk.Functions.rpad;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    24
import static info.globalcode.sql.dk.Functions.repeat;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    25
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    26
/**
155
eb3676c6929b more JavaDoc
František Kučera <franta-hg@frantovo.cz>
parents: 142
diff changeset
    27
 * Longer values are line-wrapped – the cell then contains multiple lines. Marks are added to
eb3676c6929b more JavaDoc
František Kučera <franta-hg@frantovo.cz>
parents: 142
diff changeset
    28
 * signalize forced line ends (not present in original data).
123
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    29
 *
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    30
 * @author Ing. František Kučera (frantovo.cz)
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    31
 */
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    32
public class TabularWrappingFormatter extends TabularFormatter {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    33
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    34
	public static final String NAME = "tabular-wrapping"; // bash-completion:formatter
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    35
	private List<String[]> currentRow;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    36
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    37
	public TabularWrappingFormatter(FormatterContext formatterContext) {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    38
		super(formatterContext);
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    39
	}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    40
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    41
	@Override
142
da1e38386d84 Formatters: structural change – new level „statement“ → query and parameters are no more duplicated into each result set or updates result
František Kučera <franta-hg@frantovo.cz>
parents: 123
diff changeset
    42
	public void writeStartResultSet(ColumnsHeader header) {
da1e38386d84 Formatters: structural change – new level „statement“ → query and parameters are no more duplicated into each result set or updates result
František Kučera <franta-hg@frantovo.cz>
parents: 123
diff changeset
    43
		super.writeStartResultSet(header);
123
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    44
		currentRow = new ArrayList<>(header.getColumnCount());
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    45
	}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    46
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    47
	@Override
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    48
	protected void writeColumnValueInternal(Object value) {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    49
		boolean rightAlign = value instanceof Number || value instanceof Boolean;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    50
		String valueString = String.valueOf(value);
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    51
		int columnWidth = getColumnWidth(getCurrentColumnsCount()) - 1;  // -1 = space for new line symbol
142
da1e38386d84 Formatters: structural change – new level „statement“ → query and parameters are no more duplicated into each result set or updates result
František Kučera <franta-hg@frantovo.cz>
parents: 123
diff changeset
    52
		currentRow.add(wrapLines(valueString, columnWidth, rightAlign));
123
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    53
	}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    54
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    55
	@Override
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    56
	public void writeEndRow() {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    57
		super.writeEndRow();
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    58
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    59
		int wrappedLine = 0;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    60
		boolean hasMoreWrappedLines;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    61
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    62
		do {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    63
			hasMoreWrappedLines = false;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    64
			for (int i = 0; i < currentRow.size(); i++) {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    65
				if (i == 0) {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    66
					printTableIndent();
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    67
					printTableBorder("│ ");
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    68
				} else {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    69
					printTableBorder(" │ ");
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    70
				}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    71
				String[] columnArray = currentRow.get(i);
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    72
				if (wrappedLine < columnArray.length) {
169
4e131a0b521a Tabular: replace also TABs with colored symbol (like newlines)
František Kučera <franta-hg@frantovo.cz>
parents: 155
diff changeset
    73
					printValueWithWhitespaceReplaced(columnArray[wrappedLine]);
123
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    74
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    75
					if (wrappedLine < columnArray.length - 1) {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    76
						out.print(TerminalColor.Red, "↩");
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    77
						hasMoreWrappedLines = true;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    78
					} else {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    79
						out.print(" ");
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    80
					}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    81
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    82
				} else {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    83
					out.print(repeat(' ', getColumnWidth(i + 1)));
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    84
				}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    85
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    86
				if (i == (currentRow.size() - 1)) {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    87
					printTableBorder(" │");
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    88
				}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    89
			}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    90
			out.println();
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    91
			out.flush();
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    92
			wrappedLine++;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    93
		} while (hasMoreWrappedLines);
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    94
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    95
		currentRow.clear();
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    96
	}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    97
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    98
	@Override
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
    99
	public void writeEndRowInternal() {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   100
		// already done – wrapped row ends
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   101
	}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   102
142
da1e38386d84 Formatters: structural change – new level „statement“ → query and parameters are no more duplicated into each result set or updates result
František Kučera <franta-hg@frantovo.cz>
parents: 123
diff changeset
   103
	private static String[] wrapLines(String s, int width, boolean rightAlign) {
123
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   104
		String[] array = new String[(s.length() - 1) / width + 1];
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   105
		for (int i = 0; i < array.length; i++) {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   106
			if (i == array.length - 1) {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   107
				String part = s.substring(i * width, s.length());
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   108
				array[i] = rightAlign ? lpad(part, width) : rpad(part, width);
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   109
			} else {
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   110
				array[i] = s.substring(i * width, (i + 1) * width);
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   111
			}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   112
		}
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   113
		return array;
248a98c13ca4 TabularWrappingFormatter – first version
František Kučera <franta-hg@frantovo.cz>
parents:
diff changeset
   114
	}
219
3b1733fb3793 SingleRecordFormatter: escape whitespace characters in the same way as in TabularFormatter (fixed)
František Kučera <franta-hg@frantovo.cz>
parents: 169
diff changeset
   115
}