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
     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 CSS_FILE = "info/globalcode/sql/dk/formatter/XhtmlFormatter.css";
    43 	private int resultSetCounter = 0;
    44 	private int updatesResultCounter = 0;
    45 
    46 	public XhtmlFormatter(FormatterContext formatterContext) {
    47 		super(addDefaults(formatterContext));
    48 	}
    49 
    50 	/**
    51 	 * Do not indent text – preserve whitespace for pre elements
    52 	 */
    53 	private static FormatterContext addDefaults(FormatterContext formatterContext) {
    54 		Properties defaults = new Properties(1);
    55 		defaults.add(new Property(PROPERTY_INDENT_TEXT, "false"));
    56 		formatterContext.getProperties().setLastDefaults(defaults);
    57 		return formatterContext;
    58 	}
    59 
    60 	@Override
    61 	public void writeStartBatch() {
    62 		super.writeStartBatch();
    63 		printStartDocument();
    64 		Map<QName, String> attributes = new HashMap<>(1);
    65 		attributes.put(qname("xmlns"), Xmlns.XHTML);
    66 		printStartElement(qname("html"), attributes);
    67 
    68 		printStartElement(qname("head"));
    69 		printTextElement(qname("title"), null, Constants.PROGRAM_NAME + ": batch results");
    70 		printCss();
    71 		printEndElement();
    72 
    73 		printStartElement(qname("body"));
    74 	}
    75 
    76 	private void printCss() {
    77 
    78 		try (Scanner css = new Scanner(getClass().getClassLoader().getResourceAsStream(CSS_FILE))) {
    79 			Map<QName, String> attributes = new HashMap<>(1);
    80 			attributes.put(qname("type"), "text/css");
    81 			printStartElement(qname("style"), attributes);
    82 			while (css.hasNext()) {
    83 				printText(css.nextLine(), true);
    84 			}
    85 			printEndElement();
    86 		}
    87 	}
    88 
    89 	@Override
    90 	public void writeEndBatch() {
    91 		super.writeEndBatch();
    92 		printEndElement();
    93 		printEndElement();
    94 		printEndDocument();
    95 	}
    96 
    97 	@Override
    98 	public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
    99 		super.writeStartDatabase(databaseDefinition);
   100 		printTextElement(qname("h1"), null, "Database: " + databaseDefinition.getName());
   101 
   102 		printStartElement(qname("p"));
   103 		printText("This is XHTML output of batch executed at: ", true);
   104 		printText(new Date().toString(), true);
   105 		printEndElement();
   106 	}
   107 
   108 	@Override
   109 	public void writeQuery(String sql) {
   110 		super.writeQuery(sql);
   111 		printTextElement(qname("h3"), null, "SQL:");
   112 		printTextElement(qname("pre"), null, sql);
   113 	}
   114 
   115 	@Override
   116 	public void writeParameters(List<? extends Parameter> parameters) {
   117 		super.writeParameters(parameters);
   118 
   119 		if (parameters == null || parameters.isEmpty()) {
   120 			printTextElement(qname("p"), null, "(this query has no parameters)");
   121 		} else {
   122 			printTextElement(qname("h3"), null, "Parameters:");
   123 
   124 			printStartElement(qname("table"));
   125 
   126 			printStartElement(qname("thead"));
   127 			printStartElement(qname("tr"));
   128 			printTextElement(qname("td"), null, "id");
   129 			printTextElement(qname("td"), null, "type");
   130 			printTextElement(qname("td"), null, "value");
   131 			printEndElement();
   132 			printEndElement();
   133 
   134 			printStartElement(qname("tbody"));
   135 			for (int i = 0; i < parameters.size(); i++) {
   136 				Parameter p = parameters.get(i);
   137 				printStartElement(qname("tr"));
   138 				String numberOrName;
   139 				if (p instanceof NamedParameter) {
   140 					numberOrName = ((NamedParameter) p).getName();
   141 				} else {
   142 					numberOrName = String.valueOf(i + 1);
   143 				}
   144 				printTextElement(qname("td"), null, numberOrName);
   145 				printTextElement(qname("td"), null, p.getType().name());
   146 				printTableData(p.getValue());
   147 				printEndElement();
   148 			}
   149 			printEndElement();
   150 
   151 			printEndElement();
   152 		}
   153 	}
   154 
   155 	private void printTableData(Object value) {
   156 		Map<QName, String> attributes = new HashMap<>(1);
   157 		if (value instanceof Number || value instanceof Boolean) {
   158 			attributes.put(qname("class"), "number");
   159 		}
   160 		printTextElement(qname("td"), attributes, String.valueOf(value));
   161 	}
   162 
   163 	@Override
   164 	public void writeColumnsHeader(ColumnsHeader header) {
   165 		super.writeColumnsHeader(header);
   166 		printTextElement(qname("h3"), null, "Data:");
   167 		printStartElement(qname("table"));
   168 		printStartElement(qname("thead"));
   169 		printStartElement(qname("tr"));
   170 		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
   171 			// TODO: type
   172 			printTextElement(qname("td"), null, cd.getLabel());
   173 		}
   174 		printEndElement();
   175 		printEndElement();
   176 
   177 		printStartElement(qname("tbody"));
   178 	}
   179 
   180 	@Override
   181 	public void writeStartRow() {
   182 		super.writeStartRow();
   183 		printStartElement(qname("tr"));
   184 	}
   185 
   186 	@Override
   187 	public void writeColumnValue(Object value) {
   188 		super.writeColumnValue(value);
   189 		printTableData(value);
   190 	}
   191 
   192 	@Override
   193 	public void writeEndRow() {
   194 		super.writeEndRow();
   195 		printEndElement();
   196 	}
   197 
   198 	@Override
   199 	public void writeStartResultSet() {
   200 		super.writeStartResultSet();
   201 		resultSetCounter++;
   202 		printEmptyElement(qname("hr"), null);
   203 		printTextElement(qname("h2"), null, "Result set #" + resultSetCounter);
   204 	}
   205 
   206 	@Override
   207 	public void writeEndResultSet() {
   208 		super.writeEndResultSet();
   209 		printEndElement();
   210 		printEndElement();
   211 
   212 		printTextElement(qname("p"), null, "Record count: " + getCurrentRowCount());
   213 	}
   214 
   215 	@Override
   216 	public void writeStartUpdatesResult() {
   217 		super.writeStartUpdatesResult();
   218 		updatesResultCounter++;
   219 		printEmptyElement(qname("hr"), null);
   220 		printTextElement(qname("h2"), null, "Updates result #" + updatesResultCounter);
   221 	}
   222 
   223 	@Override
   224 	public void writeUpdatedRowsCount(int updatedRowsCount) {
   225 		super.writeUpdatedRowsCount(updatedRowsCount);
   226 		printTextElement(qname("p"), null, "Updated rows: " + updatedRowsCount);
   227 	}
   228 }