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