java/sql-dk/src/info/globalcode/sql/dk/formatting/XhtmlFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Sat, 04 Jan 2014 23:44:34 +0100
branchv_0
changeset 137 3a24be5d8dac
parent 136 c0f9521900bf
child 138 b765713c60e9
permissions -rw-r--r--
XHTML formatter: distinguish number and boolean
franta-hg@128
     1
/**
franta-hg@128
     2
 * SQL-DK
franta-hg@128
     3
 * Copyright © 2014 František Kučera (frantovo.cz)
franta-hg@128
     4
 *
franta-hg@128
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@128
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@128
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@128
     8
 * (at your option) any later version.
franta-hg@128
     9
 *
franta-hg@128
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@128
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@128
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@128
    13
 * GNU General Public License for more details.
franta-hg@128
    14
 *
franta-hg@128
    15
 * You should have received a copy of the GNU General Public License
franta-hg@128
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@128
    17
 */
franta-hg@128
    18
package info.globalcode.sql.dk.formatting;
franta-hg@128
    19
franta-hg@134
    20
import info.globalcode.sql.dk.Constants;
franta-hg@134
    21
import info.globalcode.sql.dk.NamedParameter;
franta-hg@134
    22
import info.globalcode.sql.dk.Parameter;
franta-hg@134
    23
import info.globalcode.sql.dk.Xmlns;
franta-hg@134
    24
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
franta-hg@134
    25
import info.globalcode.sql.dk.configuration.Properties;
franta-hg@134
    26
import info.globalcode.sql.dk.configuration.Property;
franta-hg@134
    27
import static info.globalcode.sql.dk.formatting.AbstractXmlFormatter.qname;
franta-hg@135
    28
import java.util.Date;
franta-hg@134
    29
import java.util.HashMap;
franta-hg@134
    30
import java.util.List;
franta-hg@134
    31
import java.util.Map;
franta-hg@135
    32
import java.util.Scanner;
franta-hg@134
    33
import javax.xml.namespace.QName;
franta-hg@134
    34
franta-hg@128
    35
/**
franta-hg@128
    36
 *
franta-hg@128
    37
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@128
    38
 */
franta-hg@128
    39
public class XhtmlFormatter extends AbstractXmlFormatter {
franta-hg@128
    40
franta-hg@128
    41
	public static final String NAME = "xhtml"; // bash-completion:formatter
franta-hg@136
    42
	private static final String DOCTYPE = "html PUBLIC \"-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN\" \"http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd\"";
franta-hg@135
    43
	private static final String CSS_FILE = "info/globalcode/sql/dk/formatter/XhtmlFormatter.css";
franta-hg@134
    44
	private int resultSetCounter = 0;
franta-hg@134
    45
	private int updatesResultCounter = 0;
franta-hg@128
    46
franta-hg@128
    47
	public XhtmlFormatter(FormatterContext formatterContext) {
franta-hg@134
    48
		super(addDefaults(formatterContext));
franta-hg@134
    49
	}
franta-hg@134
    50
franta-hg@134
    51
	/**
franta-hg@134
    52
	 * Do not indent text – preserve whitespace for pre elements
franta-hg@134
    53
	 */
franta-hg@134
    54
	private static FormatterContext addDefaults(FormatterContext formatterContext) {
franta-hg@134
    55
		Properties defaults = new Properties(1);
franta-hg@134
    56
		defaults.add(new Property(PROPERTY_INDENT_TEXT, "false"));
franta-hg@134
    57
		formatterContext.getProperties().setLastDefaults(defaults);
franta-hg@134
    58
		return formatterContext;
franta-hg@134
    59
	}
franta-hg@134
    60
franta-hg@134
    61
	@Override
franta-hg@134
    62
	public void writeStartBatch() {
franta-hg@134
    63
		super.writeStartBatch();
franta-hg@134
    64
		printStartDocument();
franta-hg@136
    65
		printDoctype(DOCTYPE);
franta-hg@134
    66
		Map<QName, String> attributes = new HashMap<>(1);
franta-hg@134
    67
		attributes.put(qname("xmlns"), Xmlns.XHTML);
franta-hg@134
    68
		printStartElement(qname("html"), attributes);
franta-hg@134
    69
franta-hg@134
    70
		printStartElement(qname("head"));
franta-hg@134
    71
		printTextElement(qname("title"), null, Constants.PROGRAM_NAME + ": batch results");
franta-hg@135
    72
		printCss();
franta-hg@134
    73
		printEndElement();
franta-hg@134
    74
franta-hg@134
    75
		printStartElement(qname("body"));
franta-hg@134
    76
	}
franta-hg@134
    77
franta-hg@135
    78
	private void printCss() {
franta-hg@135
    79
franta-hg@135
    80
		try (Scanner css = new Scanner(getClass().getClassLoader().getResourceAsStream(CSS_FILE))) {
franta-hg@135
    81
			Map<QName, String> attributes = new HashMap<>(1);
franta-hg@135
    82
			attributes.put(qname("type"), "text/css");
franta-hg@135
    83
			printStartElement(qname("style"), attributes);
franta-hg@135
    84
			while (css.hasNext()) {
franta-hg@135
    85
				printText(css.nextLine(), true);
franta-hg@135
    86
			}
franta-hg@135
    87
			printEndElement();
franta-hg@135
    88
		}
franta-hg@135
    89
	}
franta-hg@135
    90
franta-hg@134
    91
	@Override
franta-hg@134
    92
	public void writeEndBatch() {
franta-hg@134
    93
		super.writeEndBatch();
franta-hg@134
    94
		printEndElement();
franta-hg@134
    95
		printEndElement();
franta-hg@134
    96
		printEndDocument();
franta-hg@134
    97
	}
franta-hg@134
    98
franta-hg@134
    99
	@Override
franta-hg@134
   100
	public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
franta-hg@134
   101
		super.writeStartDatabase(databaseDefinition);
franta-hg@134
   102
		printTextElement(qname("h1"), null, "Database: " + databaseDefinition.getName());
franta-hg@135
   103
franta-hg@135
   104
		printStartElement(qname("p"));
franta-hg@135
   105
		printText("This is XHTML output of batch executed at: ", true);
franta-hg@135
   106
		printText(new Date().toString(), true);
franta-hg@135
   107
		printEndElement();
franta-hg@134
   108
	}
franta-hg@134
   109
franta-hg@134
   110
	@Override
franta-hg@134
   111
	public void writeQuery(String sql) {
franta-hg@134
   112
		super.writeQuery(sql);
franta-hg@134
   113
		printTextElement(qname("h3"), null, "SQL:");
franta-hg@134
   114
		printTextElement(qname("pre"), null, sql);
franta-hg@134
   115
	}
franta-hg@134
   116
franta-hg@134
   117
	@Override
franta-hg@134
   118
	public void writeParameters(List<? extends Parameter> parameters) {
franta-hg@134
   119
		super.writeParameters(parameters);
franta-hg@134
   120
franta-hg@134
   121
		if (parameters == null || parameters.isEmpty()) {
franta-hg@134
   122
			printTextElement(qname("p"), null, "(this query has no parameters)");
franta-hg@134
   123
		} else {
franta-hg@134
   124
			printTextElement(qname("h3"), null, "Parameters:");
franta-hg@134
   125
franta-hg@134
   126
			printStartElement(qname("table"));
franta-hg@134
   127
franta-hg@135
   128
			printStartElement(qname("thead"));
franta-hg@134
   129
			printStartElement(qname("tr"));
franta-hg@135
   130
			printTextElement(qname("td"), null, "id");
franta-hg@134
   131
			printTextElement(qname("td"), null, "type");
franta-hg@134
   132
			printTextElement(qname("td"), null, "value");
franta-hg@134
   133
			printEndElement();
franta-hg@134
   134
			printEndElement();
franta-hg@134
   135
franta-hg@134
   136
			printStartElement(qname("tbody"));
franta-hg@134
   137
			for (int i = 0; i < parameters.size(); i++) {
franta-hg@134
   138
				Parameter p = parameters.get(i);
franta-hg@134
   139
				printStartElement(qname("tr"));
franta-hg@134
   140
				String numberOrName;
franta-hg@134
   141
				if (p instanceof NamedParameter) {
franta-hg@134
   142
					numberOrName = ((NamedParameter) p).getName();
franta-hg@134
   143
				} else {
franta-hg@134
   144
					numberOrName = String.valueOf(i + 1);
franta-hg@134
   145
				}
franta-hg@134
   146
				printTextElement(qname("td"), null, numberOrName);
franta-hg@134
   147
				printTextElement(qname("td"), null, p.getType().name());
franta-hg@135
   148
				printTableData(p.getValue());
franta-hg@134
   149
				printEndElement();
franta-hg@134
   150
			}
franta-hg@134
   151
			printEndElement();
franta-hg@134
   152
franta-hg@134
   153
			printEndElement();
franta-hg@134
   154
		}
franta-hg@134
   155
	}
franta-hg@134
   156
franta-hg@135
   157
	private void printTableData(Object value) {
franta-hg@135
   158
		Map<QName, String> attributes = new HashMap<>(1);
franta-hg@137
   159
		if (value instanceof Number) {
franta-hg@135
   160
			attributes.put(qname("class"), "number");
franta-hg@137
   161
		} else if (value instanceof Boolean) {
franta-hg@137
   162
			attributes.put(qname("class"), "boolean");
franta-hg@135
   163
		}
franta-hg@135
   164
		printTextElement(qname("td"), attributes, String.valueOf(value));
franta-hg@135
   165
	}
franta-hg@135
   166
franta-hg@134
   167
	@Override
franta-hg@134
   168
	public void writeColumnsHeader(ColumnsHeader header) {
franta-hg@134
   169
		super.writeColumnsHeader(header);
franta-hg@134
   170
		printTextElement(qname("h3"), null, "Data:");
franta-hg@134
   171
		printStartElement(qname("table"));
franta-hg@135
   172
		printStartElement(qname("thead"));
franta-hg@134
   173
		printStartElement(qname("tr"));
franta-hg@134
   174
		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
franta-hg@134
   175
			// TODO: type
franta-hg@134
   176
			printTextElement(qname("td"), null, cd.getLabel());
franta-hg@134
   177
		}
franta-hg@134
   178
		printEndElement();
franta-hg@134
   179
		printEndElement();
franta-hg@134
   180
franta-hg@134
   181
		printStartElement(qname("tbody"));
franta-hg@134
   182
	}
franta-hg@134
   183
franta-hg@134
   184
	@Override
franta-hg@134
   185
	public void writeStartRow() {
franta-hg@134
   186
		super.writeStartRow();
franta-hg@134
   187
		printStartElement(qname("tr"));
franta-hg@134
   188
	}
franta-hg@134
   189
franta-hg@134
   190
	@Override
franta-hg@134
   191
	public void writeColumnValue(Object value) {
franta-hg@134
   192
		super.writeColumnValue(value);
franta-hg@135
   193
		printTableData(value);
franta-hg@134
   194
	}
franta-hg@134
   195
franta-hg@134
   196
	@Override
franta-hg@134
   197
	public void writeEndRow() {
franta-hg@134
   198
		super.writeEndRow();
franta-hg@134
   199
		printEndElement();
franta-hg@134
   200
	}
franta-hg@134
   201
franta-hg@134
   202
	@Override
franta-hg@134
   203
	public void writeStartResultSet() {
franta-hg@134
   204
		super.writeStartResultSet();
franta-hg@134
   205
		resultSetCounter++;
franta-hg@135
   206
		printEmptyElement(qname("hr"), null);
franta-hg@135
   207
		printTextElement(qname("h2"), null, "Result set #" + resultSetCounter);
franta-hg@134
   208
	}
franta-hg@134
   209
franta-hg@134
   210
	@Override
franta-hg@134
   211
	public void writeEndResultSet() {
franta-hg@134
   212
		super.writeEndResultSet();
franta-hg@134
   213
		printEndElement();
franta-hg@134
   214
		printEndElement();
franta-hg@135
   215
franta-hg@135
   216
		printTextElement(qname("p"), null, "Record count: " + getCurrentRowCount());
franta-hg@134
   217
	}
franta-hg@134
   218
franta-hg@134
   219
	@Override
franta-hg@134
   220
	public void writeStartUpdatesResult() {
franta-hg@134
   221
		super.writeStartUpdatesResult();
franta-hg@134
   222
		updatesResultCounter++;
franta-hg@135
   223
		printEmptyElement(qname("hr"), null);
franta-hg@135
   224
		printTextElement(qname("h2"), null, "Updates result #" + updatesResultCounter);
franta-hg@134
   225
	}
franta-hg@134
   226
franta-hg@134
   227
	@Override
franta-hg@134
   228
	public void writeUpdatedRowsCount(int updatedRowsCount) {
franta-hg@134
   229
		super.writeUpdatedRowsCount(updatedRowsCount);
franta-hg@134
   230
		printTextElement(qname("p"), null, "Updated rows: " + updatedRowsCount);
franta-hg@134
   231
	}
franta-hg@128
   232
}