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
     1 /**
     2  * SQL-DK
     3  * Copyright © 2014 František Kučera (frantovo.cz)
     4  *
     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.
     9  *
    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.
    14  *
    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/>.
    17  */
    18 package info.globalcode.sql.dk.formatting;
    19 
    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;
    31 import java.util.Map;
    32 import java.util.Scanner;
    33 import javax.xml.namespace.QName;
    34 
    35 /**
    36  *
    37  * @author Ing. František Kučera (frantovo.cz)
    38  */
    39 public class XhtmlFormatter extends AbstractXmlFormatter {
    40 
    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;
    46 
    47 	public XhtmlFormatter(FormatterContext formatterContext) {
    48 		super(addDefaults(formatterContext));
    49 	}
    50 
    51 	/**
    52 	 * Do not indent text – preserve whitespace for pre elements
    53 	 */
    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;
    59 	}
    60 
    61 	@Override
    62 	public void writeStartBatch() {
    63 		super.writeStartBatch();
    64 		printStartDocument();
    65 		printDoctype(DOCTYPE);
    66 		Map<QName, String> attributes = new HashMap<>(1);
    67 		attributes.put(qname("xmlns"), Xmlns.XHTML);
    68 		printStartElement(qname("html"), attributes);
    69 
    70 		printStartElement(qname("head"));
    71 		printTextElement(qname("title"), null, Constants.PROGRAM_NAME + ": batch results");
    72 		printCss();
    73 		printEndElement();
    74 
    75 		printStartElement(qname("body"));
    76 	}
    77 
    78 	private void printCss() {
    79 
    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);
    86 			}
    87 			printEndElement();
    88 		}
    89 	}
    90 
    91 	@Override
    92 	public void writeEndBatch() {
    93 		super.writeEndBatch();
    94 		printEndElement();
    95 		printEndElement();
    96 		printEndDocument();
    97 	}
    98 
    99 	@Override
   100 	public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
   101 		super.writeStartDatabase(databaseDefinition);
   102 		printTextElement(qname("h1"), null, "Database: " + databaseDefinition.getName());
   103 
   104 		printStartElement(qname("p"));
   105 		printText("This is XHTML output of batch executed at: ", true);
   106 		printText(new Date().toString(), true);
   107 		printEndElement();
   108 	}
   109 
   110 	@Override
   111 	public void writeQuery(String sql) {
   112 		super.writeQuery(sql);
   113 		printTextElement(qname("h3"), null, "SQL:");
   114 		printTextElement(qname("pre"), null, sql);
   115 	}
   116 
   117 	@Override
   118 	public void writeParameters(List<? extends Parameter> parameters) {
   119 		super.writeParameters(parameters);
   120 
   121 		if (parameters == null || parameters.isEmpty()) {
   122 			printTextElement(qname("p"), null, "(this query has no parameters)");
   123 		} else {
   124 			printTextElement(qname("h3"), null, "Parameters:");
   125 
   126 			printStartElement(qname("table"));
   127 
   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");
   133 			printEndElement();
   134 			printEndElement();
   135 
   136 			printStartElement(qname("tbody"));
   137 			for (int i = 0; i < parameters.size(); i++) {
   138 				Parameter p = parameters.get(i);
   139 				printStartElement(qname("tr"));
   140 				String numberOrName;
   141 				if (p instanceof NamedParameter) {
   142 					numberOrName = ((NamedParameter) p).getName();
   143 				} else {
   144 					numberOrName = String.valueOf(i + 1);
   145 				}
   146 				printTextElement(qname("td"), null, numberOrName);
   147 				printTextElement(qname("td"), null, p.getType().name());
   148 				printTableData(p.getValue());
   149 				printEndElement();
   150 			}
   151 			printEndElement();
   152 
   153 			printEndElement();
   154 		}
   155 	}
   156 
   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");
   163 		}
   164 		printTextElement(qname("td"), attributes, String.valueOf(value));
   165 	}
   166 
   167 	@Override
   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()) {
   175 			// TODO: type
   176 			printTextElement(qname("td"), null, cd.getLabel());
   177 		}
   178 		printEndElement();
   179 		printEndElement();
   180 
   181 		printStartElement(qname("tbody"));
   182 	}
   183 
   184 	@Override
   185 	public void writeStartRow() {
   186 		super.writeStartRow();
   187 		printStartElement(qname("tr"));
   188 	}
   189 
   190 	@Override
   191 	public void writeColumnValue(Object value) {
   192 		super.writeColumnValue(value);
   193 		printTableData(value);
   194 	}
   195 
   196 	@Override
   197 	public void writeEndRow() {
   198 		super.writeEndRow();
   199 		printEndElement();
   200 	}
   201 
   202 	@Override
   203 	public void writeStartResultSet() {
   204 		super.writeStartResultSet();
   205 		resultSetCounter++;
   206 		printEmptyElement(qname("hr"), null);
   207 		printTextElement(qname("h2"), null, "Result set #" + resultSetCounter);
   208 	}
   209 
   210 	@Override
   211 	public void writeEndResultSet() {
   212 		super.writeEndResultSet();
   213 		printEndElement();
   214 		printEndElement();
   215 
   216 		printTextElement(qname("p"), null, "Record count: " + getCurrentRowCount());
   217 	}
   218 
   219 	@Override
   220 	public void writeStartUpdatesResult() {
   221 		super.writeStartUpdatesResult();
   222 		updatesResultCounter++;
   223 		printEmptyElement(qname("hr"), null);
   224 		printTextElement(qname("h2"), null, "Updates result #" + updatesResultCounter);
   225 	}
   226 
   227 	@Override
   228 	public void writeUpdatedRowsCount(int updatedRowsCount) {
   229 		super.writeUpdatedRowsCount(updatedRowsCount);
   230 		printTextElement(qname("p"), null, "Updated rows: " + updatedRowsCount);
   231 	}
   232 }