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:27:17 +0100
branchv_0
changeset 135 ef432015fdee
parent 134 f2510551b5bf
child 136 c0f9521900bf
permissions -rw-r--r--
XHTML formatter: CSS and other improvements

/**
 * SQL-DK
 * Copyright © 2014 František Kučera (frantovo.cz)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package info.globalcode.sql.dk.formatting;

import info.globalcode.sql.dk.Constants;
import info.globalcode.sql.dk.NamedParameter;
import info.globalcode.sql.dk.Parameter;
import info.globalcode.sql.dk.Xmlns;
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
import info.globalcode.sql.dk.configuration.Properties;
import info.globalcode.sql.dk.configuration.Property;
import static info.globalcode.sql.dk.formatting.AbstractXmlFormatter.qname;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Scanner;
import javax.xml.namespace.QName;

/**
 *
 * @author Ing. František Kučera (frantovo.cz)
 */
public class XhtmlFormatter extends AbstractXmlFormatter {

	public static final String NAME = "xhtml"; // bash-completion:formatter
	private static final String CSS_FILE = "info/globalcode/sql/dk/formatter/XhtmlFormatter.css";
	private int resultSetCounter = 0;
	private int updatesResultCounter = 0;

	public XhtmlFormatter(FormatterContext formatterContext) {
		super(addDefaults(formatterContext));
	}

	/**
	 * Do not indent text – preserve whitespace for pre elements
	 */
	private static FormatterContext addDefaults(FormatterContext formatterContext) {
		Properties defaults = new Properties(1);
		defaults.add(new Property(PROPERTY_INDENT_TEXT, "false"));
		formatterContext.getProperties().setLastDefaults(defaults);
		return formatterContext;
	}

	@Override
	public void writeStartBatch() {
		super.writeStartBatch();
		printStartDocument();
		Map<QName, String> attributes = new HashMap<>(1);
		attributes.put(qname("xmlns"), Xmlns.XHTML);
		printStartElement(qname("html"), attributes);

		printStartElement(qname("head"));
		printTextElement(qname("title"), null, Constants.PROGRAM_NAME + ": batch results");
		printCss();
		printEndElement();

		printStartElement(qname("body"));
	}

	private void printCss() {

		try (Scanner css = new Scanner(getClass().getClassLoader().getResourceAsStream(CSS_FILE))) {
			Map<QName, String> attributes = new HashMap<>(1);
			attributes.put(qname("type"), "text/css");
			printStartElement(qname("style"), attributes);
			while (css.hasNext()) {
				printText(css.nextLine(), true);
			}
			printEndElement();
		}
	}

	@Override
	public void writeEndBatch() {
		super.writeEndBatch();
		printEndElement();
		printEndElement();
		printEndDocument();
	}

	@Override
	public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
		super.writeStartDatabase(databaseDefinition);
		printTextElement(qname("h1"), null, "Database: " + databaseDefinition.getName());

		printStartElement(qname("p"));
		printText("This is XHTML output of batch executed at: ", true);
		printText(new Date().toString(), true);
		printEndElement();
	}

	@Override
	public void writeQuery(String sql) {
		super.writeQuery(sql);
		printTextElement(qname("h3"), null, "SQL:");
		printTextElement(qname("pre"), null, sql);
	}

	@Override
	public void writeParameters(List<? extends Parameter> parameters) {
		super.writeParameters(parameters);

		if (parameters == null || parameters.isEmpty()) {
			printTextElement(qname("p"), null, "(this query has no parameters)");
		} else {
			printTextElement(qname("h3"), null, "Parameters:");

			printStartElement(qname("table"));

			printStartElement(qname("thead"));
			printStartElement(qname("tr"));
			printTextElement(qname("td"), null, "id");
			printTextElement(qname("td"), null, "type");
			printTextElement(qname("td"), null, "value");
			printEndElement();
			printEndElement();

			printStartElement(qname("tbody"));
			for (int i = 0; i < parameters.size(); i++) {
				Parameter p = parameters.get(i);
				printStartElement(qname("tr"));
				String numberOrName;
				if (p instanceof NamedParameter) {
					numberOrName = ((NamedParameter) p).getName();
				} else {
					numberOrName = String.valueOf(i + 1);
				}
				printTextElement(qname("td"), null, numberOrName);
				printTextElement(qname("td"), null, p.getType().name());
				printTableData(p.getValue());
				printEndElement();
			}
			printEndElement();

			printEndElement();
		}
	}

	private void printTableData(Object value) {
		Map<QName, String> attributes = new HashMap<>(1);
		if (value instanceof Number || value instanceof Boolean) {
			attributes.put(qname("class"), "number");
		}
		printTextElement(qname("td"), attributes, String.valueOf(value));
	}

	@Override
	public void writeColumnsHeader(ColumnsHeader header) {
		super.writeColumnsHeader(header);
		printTextElement(qname("h3"), null, "Data:");
		printStartElement(qname("table"));
		printStartElement(qname("thead"));
		printStartElement(qname("tr"));
		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
			// TODO: type
			printTextElement(qname("td"), null, cd.getLabel());
		}
		printEndElement();
		printEndElement();

		printStartElement(qname("tbody"));
	}

	@Override
	public void writeStartRow() {
		super.writeStartRow();
		printStartElement(qname("tr"));
	}

	@Override
	public void writeColumnValue(Object value) {
		super.writeColumnValue(value);
		printTableData(value);
	}

	@Override
	public void writeEndRow() {
		super.writeEndRow();
		printEndElement();
	}

	@Override
	public void writeStartResultSet() {
		super.writeStartResultSet();
		resultSetCounter++;
		printEmptyElement(qname("hr"), null);
		printTextElement(qname("h2"), null, "Result set #" + resultSetCounter);
	}

	@Override
	public void writeEndResultSet() {
		super.writeEndResultSet();
		printEndElement();
		printEndElement();

		printTextElement(qname("p"), null, "Record count: " + getCurrentRowCount());
	}

	@Override
	public void writeStartUpdatesResult() {
		super.writeStartUpdatesResult();
		updatesResultCounter++;
		printEmptyElement(qname("hr"), null);
		printTextElement(qname("h2"), null, "Updates result #" + updatesResultCounter);
	}

	@Override
	public void writeUpdatedRowsCount(int updatedRowsCount) {
		super.writeUpdatedRowsCount(updatedRowsCount);
		printTextElement(qname("p"), null, "Updated rows: " + updatedRowsCount);
	}
}