java/sql-dk/src/info/globalcode/sql/dk/formatting/XhtmlFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Wed, 08 Jan 2014 23:50:22 +0100
branchv_0
changeset 152 7a3382823fc3
parent 142 da1e38386d84
child 155 eb3676c6929b
permissions -rw-r--r--
XML formatter: use singleAttribute(qname(""), "")
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@138
    28
import java.sql.Array;
franta-hg@138
    29
import java.sql.SQLException;
franta-hg@135
    30
import java.util.Date;
franta-hg@134
    31
import java.util.List;
franta-hg@134
    32
import java.util.Map;
franta-hg@135
    33
import java.util.Scanner;
franta-hg@138
    34
import java.util.logging.Level;
franta-hg@138
    35
import java.util.logging.Logger;
franta-hg@134
    36
import javax.xml.namespace.QName;
franta-hg@134
    37
franta-hg@128
    38
/**
franta-hg@128
    39
 *
franta-hg@128
    40
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@128
    41
 */
franta-hg@128
    42
public class XhtmlFormatter extends AbstractXmlFormatter {
franta-hg@128
    43
franta-hg@138
    44
	private static final Logger log = Logger.getLogger(XhtmlFormatter.class.getName());
franta-hg@128
    45
	public static final String NAME = "xhtml"; // bash-completion:formatter
franta-hg@136
    46
	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
    47
	private static final String CSS_FILE = "info/globalcode/sql/dk/formatter/XhtmlFormatter.css";
franta-hg@142
    48
	private int statementCounter = 0;
franta-hg@134
    49
	private int resultSetCounter = 0;
franta-hg@134
    50
	private int updatesResultCounter = 0;
franta-hg@128
    51
franta-hg@128
    52
	public XhtmlFormatter(FormatterContext formatterContext) {
franta-hg@134
    53
		super(addDefaults(formatterContext));
franta-hg@134
    54
	}
franta-hg@134
    55
franta-hg@134
    56
	/**
franta-hg@134
    57
	 * Do not indent text – preserve whitespace for pre elements
franta-hg@134
    58
	 */
franta-hg@134
    59
	private static FormatterContext addDefaults(FormatterContext formatterContext) {
franta-hg@134
    60
		Properties defaults = new Properties(1);
franta-hg@134
    61
		defaults.add(new Property(PROPERTY_INDENT_TEXT, "false"));
franta-hg@134
    62
		formatterContext.getProperties().setLastDefaults(defaults);
franta-hg@134
    63
		return formatterContext;
franta-hg@134
    64
	}
franta-hg@134
    65
franta-hg@134
    66
	@Override
franta-hg@134
    67
	public void writeStartBatch() {
franta-hg@134
    68
		super.writeStartBatch();
franta-hg@134
    69
		printStartDocument();
franta-hg@136
    70
		printDoctype(DOCTYPE);
franta-hg@152
    71
		printStartElement(qname("html"), singleAttribute(qname("xmlns"), Xmlns.XHTML));
franta-hg@134
    72
franta-hg@134
    73
		printStartElement(qname("head"));
franta-hg@134
    74
		printTextElement(qname("title"), null, Constants.PROGRAM_NAME + ": batch results");
franta-hg@135
    75
		printCss();
franta-hg@134
    76
		printEndElement();
franta-hg@134
    77
franta-hg@134
    78
		printStartElement(qname("body"));
franta-hg@134
    79
	}
franta-hg@134
    80
franta-hg@135
    81
	private void printCss() {
franta-hg@135
    82
franta-hg@135
    83
		try (Scanner css = new Scanner(getClass().getClassLoader().getResourceAsStream(CSS_FILE))) {
franta-hg@152
    84
			printStartElement(qname("style"), singleAttribute(qname("type"), "text/css"));
franta-hg@135
    85
			while (css.hasNext()) {
franta-hg@135
    86
				printText(css.nextLine(), true);
franta-hg@135
    87
			}
franta-hg@135
    88
			printEndElement();
franta-hg@135
    89
		}
franta-hg@135
    90
	}
franta-hg@135
    91
franta-hg@134
    92
	@Override
franta-hg@134
    93
	public void writeEndBatch() {
franta-hg@134
    94
		super.writeEndBatch();
franta-hg@134
    95
		printEndElement();
franta-hg@134
    96
		printEndElement();
franta-hg@134
    97
		printEndDocument();
franta-hg@134
    98
	}
franta-hg@134
    99
franta-hg@134
   100
	@Override
franta-hg@134
   101
	public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
franta-hg@134
   102
		super.writeStartDatabase(databaseDefinition);
franta-hg@134
   103
		printTextElement(qname("h1"), null, "Database: " + databaseDefinition.getName());
franta-hg@135
   104
franta-hg@135
   105
		printStartElement(qname("p"));
franta-hg@135
   106
		printText("This is XHTML output of batch executed at: ", true);
franta-hg@135
   107
		printText(new Date().toString(), true);
franta-hg@135
   108
		printEndElement();
franta-hg@134
   109
	}
franta-hg@134
   110
franta-hg@134
   111
	@Override
franta-hg@134
   112
	public void writeQuery(String sql) {
franta-hg@134
   113
		super.writeQuery(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@138
   158
franta-hg@138
   159
		if (value instanceof Array) {
franta-hg@138
   160
			Array sqlArray = (Array) value;
franta-hg@138
   161
			try {
franta-hg@138
   162
				Object[] array = (Object[]) sqlArray.getArray();
franta-hg@138
   163
				printStartElement(qname("td"));
franta-hg@138
   164
				printArray(array);
franta-hg@138
   165
				printEndElement();
franta-hg@138
   166
			} catch (SQLException e) {
franta-hg@138
   167
				log.log(Level.SEVERE, "Unable to format array", e);
franta-hg@138
   168
				printTableData(String.valueOf(value));
franta-hg@138
   169
			}
franta-hg@138
   170
		} else {
franta-hg@152
   171
			Map<QName, String> attributes = null;
franta-hg@138
   172
			if (value instanceof Number) {
franta-hg@152
   173
				attributes = singleAttribute(qname("class"), "number");
franta-hg@138
   174
			} else if (value instanceof Boolean) {
franta-hg@152
   175
				attributes = singleAttribute(qname("class"), "boolean");
franta-hg@138
   176
			}
franta-hg@138
   177
			printTextElement(qname("td"), attributes, String.valueOf(value));
franta-hg@135
   178
		}
franta-hg@138
   179
	}
franta-hg@138
   180
franta-hg@138
   181
	private void printArray(Object[] array) {
franta-hg@138
   182
		printStartElement(qname("ul"));
franta-hg@138
   183
		for (Object o : array) {
franta-hg@138
   184
			if (o instanceof Object[]) {
franta-hg@138
   185
				printStartElement(qname("li"));
franta-hg@138
   186
				printTextElement(qname("p"), null, "nested array:");
franta-hg@138
   187
				printArray((Object[]) o);
franta-hg@138
   188
				printEndElement();
franta-hg@138
   189
			} else {
franta-hg@138
   190
				printTextElement(qname("li"), null, String.valueOf(o));
franta-hg@138
   191
			}
franta-hg@138
   192
		}
franta-hg@138
   193
		printEndElement();
franta-hg@135
   194
	}
franta-hg@135
   195
franta-hg@134
   196
	@Override
franta-hg@142
   197
	public void writeStartResultSet(ColumnsHeader header) {
franta-hg@142
   198
		super.writeStartResultSet(header);
franta-hg@142
   199
		resultSetCounter++;
franta-hg@142
   200
		printEmptyElement(qname("hr"), null);
franta-hg@142
   201
		printTextElement(qname("h3"), null, "Result set #" + resultSetCounter);
franta-hg@134
   202
		printStartElement(qname("table"));
franta-hg@135
   203
		printStartElement(qname("thead"));
franta-hg@134
   204
		printStartElement(qname("tr"));
franta-hg@134
   205
		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
franta-hg@134
   206
			// TODO: type
franta-hg@134
   207
			printTextElement(qname("td"), null, cd.getLabel());
franta-hg@134
   208
		}
franta-hg@134
   209
		printEndElement();
franta-hg@134
   210
		printEndElement();
franta-hg@134
   211
franta-hg@134
   212
		printStartElement(qname("tbody"));
franta-hg@134
   213
	}
franta-hg@134
   214
franta-hg@134
   215
	@Override
franta-hg@142
   216
	public void writeEndResultSet() {
franta-hg@142
   217
		super.writeEndResultSet();
franta-hg@142
   218
		printEndElement();
franta-hg@142
   219
		printEndElement();
franta-hg@142
   220
		printTextElement(qname("p"), null, "Record count: " + getCurrentRowCount());
franta-hg@142
   221
	}
franta-hg@142
   222
franta-hg@142
   223
	@Override
franta-hg@134
   224
	public void writeStartRow() {
franta-hg@134
   225
		super.writeStartRow();
franta-hg@134
   226
		printStartElement(qname("tr"));
franta-hg@134
   227
	}
franta-hg@134
   228
franta-hg@134
   229
	@Override
franta-hg@134
   230
	public void writeColumnValue(Object value) {
franta-hg@134
   231
		super.writeColumnValue(value);
franta-hg@135
   232
		printTableData(value);
franta-hg@134
   233
	}
franta-hg@134
   234
franta-hg@134
   235
	@Override
franta-hg@134
   236
	public void writeEndRow() {
franta-hg@134
   237
		super.writeEndRow();
franta-hg@134
   238
		printEndElement();
franta-hg@134
   239
	}
franta-hg@134
   240
franta-hg@134
   241
	@Override
franta-hg@142
   242
	public void writeStartStatement() {
franta-hg@142
   243
		super.writeStartStatement();
franta-hg@142
   244
		statementCounter++;
franta-hg@135
   245
		printEmptyElement(qname("hr"), null);
franta-hg@142
   246
		printTextElement(qname("h2"), null, "SQL statement #" + statementCounter);
franta-hg@142
   247
		resultSetCounter = 0;
franta-hg@142
   248
		updatesResultCounter = 0;
franta-hg@134
   249
	}
franta-hg@134
   250
franta-hg@134
   251
	@Override
franta-hg@142
   252
	public void writeUpdatesResult(int updatedRowsCount) {
franta-hg@142
   253
		super.writeUpdatesResult(updatedRowsCount);
franta-hg@134
   254
		updatesResultCounter++;
franta-hg@135
   255
		printEmptyElement(qname("hr"), null);
franta-hg@142
   256
		printTextElement(qname("h3"), null, "Updates result #" + updatesResultCounter);
franta-hg@134
   257
		printTextElement(qname("p"), null, "Updated rows: " + updatedRowsCount);
franta-hg@134
   258
	}
franta-hg@128
   259
}