3 * Copyright © 2014 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.Constants;
21 import info.globalcode.sql.dk.NamedParameter;
22 import info.globalcode.sql.dk.Parameter;
23 import info.globalcode.sql.dk.Xmlns;
24 import info.globalcode.sql.dk.configuration.DatabaseDefinition;
25 import info.globalcode.sql.dk.configuration.Properties;
26 import info.globalcode.sql.dk.configuration.Property;
27 import static info.globalcode.sql.dk.formatting.AbstractXmlFormatter.qname;
28 import java.util.Date;
29 import java.util.HashMap;
30 import java.util.List;
32 import java.util.Scanner;
33 import javax.xml.namespace.QName;
37 * @author Ing. František Kučera (frantovo.cz)
39 public class XhtmlFormatter extends AbstractXmlFormatter {
41 public static final String NAME = "xhtml"; // bash-completion:formatter
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\"";
43 private static final String CSS_FILE = "info/globalcode/sql/dk/formatter/XhtmlFormatter.css";
44 private int resultSetCounter = 0;
45 private int updatesResultCounter = 0;
47 public XhtmlFormatter(FormatterContext formatterContext) {
48 super(addDefaults(formatterContext));
52 * Do not indent text – preserve whitespace for pre elements
54 private static FormatterContext addDefaults(FormatterContext formatterContext) {
55 Properties defaults = new Properties(1);
56 defaults.add(new Property(PROPERTY_INDENT_TEXT, "false"));
57 formatterContext.getProperties().setLastDefaults(defaults);
58 return formatterContext;
62 public void writeStartBatch() {
63 super.writeStartBatch();
65 printDoctype(DOCTYPE);
66 Map<QName, String> attributes = new HashMap<>(1);
67 attributes.put(qname("xmlns"), Xmlns.XHTML);
68 printStartElement(qname("html"), attributes);
70 printStartElement(qname("head"));
71 printTextElement(qname("title"), null, Constants.PROGRAM_NAME + ": batch results");
75 printStartElement(qname("body"));
78 private void printCss() {
80 try (Scanner css = new Scanner(getClass().getClassLoader().getResourceAsStream(CSS_FILE))) {
81 Map<QName, String> attributes = new HashMap<>(1);
82 attributes.put(qname("type"), "text/css");
83 printStartElement(qname("style"), attributes);
84 while (css.hasNext()) {
85 printText(css.nextLine(), true);
92 public void writeEndBatch() {
93 super.writeEndBatch();
100 public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
101 super.writeStartDatabase(databaseDefinition);
102 printTextElement(qname("h1"), null, "Database: " + databaseDefinition.getName());
104 printStartElement(qname("p"));
105 printText("This is XHTML output of batch executed at: ", true);
106 printText(new Date().toString(), true);
111 public void writeQuery(String sql) {
112 super.writeQuery(sql);
113 printTextElement(qname("h3"), null, "SQL:");
114 printTextElement(qname("pre"), null, sql);
118 public void writeParameters(List<? extends Parameter> parameters) {
119 super.writeParameters(parameters);
121 if (parameters == null || parameters.isEmpty()) {
122 printTextElement(qname("p"), null, "(this query has no parameters)");
124 printTextElement(qname("h3"), null, "Parameters:");
126 printStartElement(qname("table"));
128 printStartElement(qname("thead"));
129 printStartElement(qname("tr"));
130 printTextElement(qname("td"), null, "id");
131 printTextElement(qname("td"), null, "type");
132 printTextElement(qname("td"), null, "value");
136 printStartElement(qname("tbody"));
137 for (int i = 0; i < parameters.size(); i++) {
138 Parameter p = parameters.get(i);
139 printStartElement(qname("tr"));
141 if (p instanceof NamedParameter) {
142 numberOrName = ((NamedParameter) p).getName();
144 numberOrName = String.valueOf(i + 1);
146 printTextElement(qname("td"), null, numberOrName);
147 printTextElement(qname("td"), null, p.getType().name());
148 printTableData(p.getValue());
157 private void printTableData(Object value) {
158 Map<QName, String> attributes = new HashMap<>(1);
159 if (value instanceof Number) {
160 attributes.put(qname("class"), "number");
161 } else if (value instanceof Boolean) {
162 attributes.put(qname("class"), "boolean");
164 printTextElement(qname("td"), attributes, String.valueOf(value));
168 public void writeColumnsHeader(ColumnsHeader header) {
169 super.writeColumnsHeader(header);
170 printTextElement(qname("h3"), null, "Data:");
171 printStartElement(qname("table"));
172 printStartElement(qname("thead"));
173 printStartElement(qname("tr"));
174 for (ColumnDescriptor cd : header.getColumnDescriptors()) {
176 printTextElement(qname("td"), null, cd.getLabel());
181 printStartElement(qname("tbody"));
185 public void writeStartRow() {
186 super.writeStartRow();
187 printStartElement(qname("tr"));
191 public void writeColumnValue(Object value) {
192 super.writeColumnValue(value);
193 printTableData(value);
197 public void writeEndRow() {
203 public void writeStartResultSet() {
204 super.writeStartResultSet();
206 printEmptyElement(qname("hr"), null);
207 printTextElement(qname("h2"), null, "Result set #" + resultSetCounter);
211 public void writeEndResultSet() {
212 super.writeEndResultSet();
216 printTextElement(qname("p"), null, "Record count: " + getCurrentRowCount());
220 public void writeStartUpdatesResult() {
221 super.writeStartUpdatesResult();
222 updatesResultCounter++;
223 printEmptyElement(qname("hr"), null);
224 printTextElement(qname("h2"), null, "Updates result #" + updatesResultCounter);
228 public void writeUpdatedRowsCount(int updatedRowsCount) {
229 super.writeUpdatedRowsCount(updatedRowsCount);
230 printTextElement(qname("p"), null, "Updated rows: " + updatedRowsCount);