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 java.sql.Array;
28 import java.sql.SQLException;
29 import java.util.Date;
30 import java.util.List;
32 import java.util.Scanner;
33 import java.util.logging.Level;
34 import java.util.logging.Logger;
35 import javax.xml.namespace.QName;
38 * Prints result sets and parameters as tables, SQL as preformatted and updates counts as
39 * paragraphs. You can pick XHTML fragments (usually tabular data) and use it on your website or use
40 * whole output as preview or report.
42 * @author Ing. František Kučera (frantovo.cz)
44 public class XhtmlFormatter extends AbstractXmlFormatter {
46 private static final Logger log = Logger.getLogger(XhtmlFormatter.class.getName());
47 public static final String NAME = "xhtml"; // bash-completion:formatter
48 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\"";
49 private static final String CSS_FILE = "info/globalcode/sql/dk/formatter/XhtmlFormatter.css";
50 private int statementCounter = 0;
51 private int resultSetCounter = 0;
52 private int updatesResultCounter = 0;
54 public XhtmlFormatter(FormatterContext formatterContext) {
55 super(addDefaults(formatterContext));
58 private QName qname(String localPart) {
59 return new QName(Xmlns.XHTML, localPart);
63 * Do not indent text – preserve whitespace for pre elements
65 private static FormatterContext addDefaults(FormatterContext formatterContext) {
66 Properties defaults = new Properties(1);
67 defaults.add(new Property(PROPERTY_INDENT_TEXT, "false"));
68 formatterContext.getProperties().setLastDefaults(defaults);
69 return formatterContext;
73 public void writeStartBatch() {
74 super.writeStartBatch();
76 printDoctype(DOCTYPE);
77 printStartElement(qname("html"), singleAttribute(qname("xmlns"), Xmlns.XHTML));
79 printStartElement(qname("head"));
80 printTextElement(qname("title"), null, Constants.PROGRAM_NAME + ": batch results");
84 printStartElement(qname("body"));
87 private void printCss() {
89 try (Scanner css = new Scanner(getClass().getClassLoader().getResourceAsStream(CSS_FILE))) {
90 printStartElement(qname("style"), singleAttribute(qname("type"), "text/css"));
91 while (css.hasNext()) {
92 printText(css.nextLine(), true);
99 public void writeEndBatch() {
100 super.writeEndBatch();
107 public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
108 super.writeStartDatabase(databaseDefinition);
109 printTextElement(qname("h1"), null, "Database: " + databaseDefinition.getName());
111 printStartElement(qname("p"));
112 printText("This is XHTML output of batch executed at: ", true);
113 printText(new Date().toString(), true);
118 public void writeQuery(String sql) {
119 super.writeQuery(sql);
120 printTextElement(qname("pre"), null, sql);
124 public void writeParameters(List<? extends Parameter> parameters) {
125 super.writeParameters(parameters);
127 if (parameters == null || parameters.isEmpty()) {
128 printTextElement(qname("p"), null, "(this query has no parameters)");
130 printTextElement(qname("h3"), null, "Parameters:");
132 printStartElement(qname("table"));
134 printStartElement(qname("thead"));
135 printStartElement(qname("tr"));
136 printTextElement(qname("td"), null, "id");
137 printTextElement(qname("td"), null, "type");
138 printTextElement(qname("td"), null, "value");
142 printStartElement(qname("tbody"));
143 for (int i = 0; i < parameters.size(); i++) {
144 Parameter p = parameters.get(i);
145 printStartElement(qname("tr"));
147 if (p instanceof NamedParameter) {
148 numberOrName = ((NamedParameter) p).getName();
150 numberOrName = String.valueOf(i + 1);
152 printTextElement(qname("td"), null, numberOrName);
153 printTextElement(qname("td"), null, p.getType().name());
154 printTableData(p.getValue());
163 private void printTableData(Object value) {
165 if (value instanceof Array) {
166 Array sqlArray = (Array) value;
168 Object[] array = (Object[]) sqlArray.getArray();
169 printStartElement(qname("td"));
172 } catch (SQLException e) {
173 log.log(Level.SEVERE, "Unable to format array", e);
174 printTableData(String.valueOf(value));
177 Map<QName, String> attributes = null;
178 if (value instanceof Number) {
179 attributes = singleAttribute(qname("class"), "number");
180 } else if (value instanceof Boolean) {
181 attributes = singleAttribute(qname("class"), "boolean");
183 printTextElement(qname("td"), attributes, String.valueOf(value));
187 private void printArray(Object[] array) {
188 printStartElement(qname("ul"));
189 for (Object o : array) {
190 if (o instanceof Object[]) {
191 printStartElement(qname("li"));
192 printTextElement(qname("p"), null, "nested array:");
193 printArray((Object[]) o);
196 printTextElement(qname("li"), null, String.valueOf(o));
203 public void writeStartResultSet(ColumnsHeader header) {
204 super.writeStartResultSet(header);
206 printEmptyElement(qname("hr"), null);
207 printTextElement(qname("h3"), null, "Result set #" + resultSetCounter);
208 printStartElement(qname("table"));
209 printStartElement(qname("thead"));
210 printStartElement(qname("tr"));
211 for (ColumnDescriptor cd : header.getColumnDescriptors()) {
213 printTextElement(qname("td"), null, cd.getLabel());
218 printStartElement(qname("tbody"));
222 public void writeEndResultSet() {
223 super.writeEndResultSet();
226 printTextElement(qname("p"), null, "Record count: " + getCurrentRowCount());
230 public void writeStartRow() {
231 super.writeStartRow();
232 printStartElement(qname("tr"));
236 public void writeColumnValue(Object value) {
237 super.writeColumnValue(value);
238 printTableData(value);
242 public void writeEndRow() {
248 public void writeStartStatement() {
249 super.writeStartStatement();
251 printEmptyElement(qname("hr"), null);
252 printTextElement(qname("h2"), null, "SQL statement #" + statementCounter);
253 resultSetCounter = 0;
254 updatesResultCounter = 0;
258 public void writeUpdatesResult(int updatedRowsCount) {
259 super.writeUpdatesResult(updatedRowsCount);
260 updatesResultCounter++;
261 printEmptyElement(qname("hr"), null);
262 printTextElement(qname("h3"), null, "Updates result #" + updatesResultCounter);
263 printTextElement(qname("p"), null, "Updated rows: " + updatedRowsCount);