java/sql-dk/src/info/globalcode/sql/dk/formatting/XhtmlFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Sun, 05 Jan 2014 00:17:27 +0100
branchv_0
changeset 138 b765713c60e9
parent 137 3a24be5d8dac
child 142 da1e38386d84
permissions -rw-r--r--
XHTML formatter: simple formatting of (multidimensional) arrays
     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.HashMap;
    32 import java.util.List;
    33 import java.util.Map;
    34 import java.util.Scanner;
    35 import java.util.logging.Level;
    36 import java.util.logging.Logger;
    37 import javax.xml.namespace.QName;
    38 
    39 /**
    40  *
    41  * @author Ing. František Kučera (frantovo.cz)
    42  */
    43 public class XhtmlFormatter extends AbstractXmlFormatter {
    44 
    45 	private static final Logger log = Logger.getLogger(XhtmlFormatter.class.getName());
    46 	public static final String NAME = "xhtml"; // bash-completion:formatter
    47 	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\"";
    48 	private static final String CSS_FILE = "info/globalcode/sql/dk/formatter/XhtmlFormatter.css";
    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 		Map<QName, String> attributes = new HashMap<>(1);
    72 		attributes.put(qname("xmlns"), Xmlns.XHTML);
    73 		printStartElement(qname("html"), attributes);
    74 
    75 		printStartElement(qname("head"));
    76 		printTextElement(qname("title"), null, Constants.PROGRAM_NAME + ": batch results");
    77 		printCss();
    78 		printEndElement();
    79 
    80 		printStartElement(qname("body"));
    81 	}
    82 
    83 	private void printCss() {
    84 
    85 		try (Scanner css = new Scanner(getClass().getClassLoader().getResourceAsStream(CSS_FILE))) {
    86 			Map<QName, String> attributes = new HashMap<>(1);
    87 			attributes.put(qname("type"), "text/css");
    88 			printStartElement(qname("style"), attributes);
    89 			while (css.hasNext()) {
    90 				printText(css.nextLine(), true);
    91 			}
    92 			printEndElement();
    93 		}
    94 	}
    95 
    96 	@Override
    97 	public void writeEndBatch() {
    98 		super.writeEndBatch();
    99 		printEndElement();
   100 		printEndElement();
   101 		printEndDocument();
   102 	}
   103 
   104 	@Override
   105 	public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
   106 		super.writeStartDatabase(databaseDefinition);
   107 		printTextElement(qname("h1"), null, "Database: " + databaseDefinition.getName());
   108 
   109 		printStartElement(qname("p"));
   110 		printText("This is XHTML output of batch executed at: ", true);
   111 		printText(new Date().toString(), true);
   112 		printEndElement();
   113 	}
   114 
   115 	@Override
   116 	public void writeQuery(String sql) {
   117 		super.writeQuery(sql);
   118 		printTextElement(qname("h3"), null, "SQL:");
   119 		printTextElement(qname("pre"), null, sql);
   120 	}
   121 
   122 	@Override
   123 	public void writeParameters(List<? extends Parameter> parameters) {
   124 		super.writeParameters(parameters);
   125 
   126 		if (parameters == null || parameters.isEmpty()) {
   127 			printTextElement(qname("p"), null, "(this query has no parameters)");
   128 		} else {
   129 			printTextElement(qname("h3"), null, "Parameters:");
   130 
   131 			printStartElement(qname("table"));
   132 
   133 			printStartElement(qname("thead"));
   134 			printStartElement(qname("tr"));
   135 			printTextElement(qname("td"), null, "id");
   136 			printTextElement(qname("td"), null, "type");
   137 			printTextElement(qname("td"), null, "value");
   138 			printEndElement();
   139 			printEndElement();
   140 
   141 			printStartElement(qname("tbody"));
   142 			for (int i = 0; i < parameters.size(); i++) {
   143 				Parameter p = parameters.get(i);
   144 				printStartElement(qname("tr"));
   145 				String numberOrName;
   146 				if (p instanceof NamedParameter) {
   147 					numberOrName = ((NamedParameter) p).getName();
   148 				} else {
   149 					numberOrName = String.valueOf(i + 1);
   150 				}
   151 				printTextElement(qname("td"), null, numberOrName);
   152 				printTextElement(qname("td"), null, p.getType().name());
   153 				printTableData(p.getValue());
   154 				printEndElement();
   155 			}
   156 			printEndElement();
   157 
   158 			printEndElement();
   159 		}
   160 	}
   161 
   162 	private void printTableData(Object value) {
   163 
   164 		if (value instanceof Array) {
   165 			Array sqlArray = (Array) value;
   166 			try {
   167 				Object[] array = (Object[]) sqlArray.getArray();
   168 				printStartElement(qname("td"));
   169 				printArray(array);
   170 				printEndElement();
   171 			} catch (SQLException e) {
   172 				log.log(Level.SEVERE, "Unable to format array", e);
   173 				printTableData(String.valueOf(value));
   174 			}
   175 		} else {
   176 			Map<QName, String> attributes = new HashMap<>(1);
   177 			if (value instanceof Number) {
   178 				attributes.put(qname("class"), "number");
   179 			} else if (value instanceof Boolean) {
   180 				attributes.put(qname("class"), "boolean");
   181 			}
   182 			printTextElement(qname("td"), attributes, String.valueOf(value));
   183 		}
   184 	}
   185 
   186 	private void printArray(Object[] array) {
   187 		printStartElement(qname("ul"));
   188 		for (Object o : array) {
   189 			if (o instanceof Object[]) {
   190 				printStartElement(qname("li"));
   191 				printTextElement(qname("p"), null, "nested array:");
   192 				printArray((Object[]) o);
   193 				printEndElement();
   194 			} else {
   195 				printTextElement(qname("li"), null, String.valueOf(o));
   196 			}
   197 		}
   198 		printEndElement();
   199 	}
   200 
   201 	@Override
   202 	public void writeColumnsHeader(ColumnsHeader header) {
   203 		super.writeColumnsHeader(header);
   204 		printTextElement(qname("h3"), null, "Data:");
   205 		printStartElement(qname("table"));
   206 		printStartElement(qname("thead"));
   207 		printStartElement(qname("tr"));
   208 		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
   209 			// TODO: type
   210 			printTextElement(qname("td"), null, cd.getLabel());
   211 		}
   212 		printEndElement();
   213 		printEndElement();
   214 
   215 		printStartElement(qname("tbody"));
   216 	}
   217 
   218 	@Override
   219 	public void writeStartRow() {
   220 		super.writeStartRow();
   221 		printStartElement(qname("tr"));
   222 	}
   223 
   224 	@Override
   225 	public void writeColumnValue(Object value) {
   226 		super.writeColumnValue(value);
   227 		printTableData(value);
   228 	}
   229 
   230 	@Override
   231 	public void writeEndRow() {
   232 		super.writeEndRow();
   233 		printEndElement();
   234 	}
   235 
   236 	@Override
   237 	public void writeStartResultSet() {
   238 		super.writeStartResultSet();
   239 		resultSetCounter++;
   240 		printEmptyElement(qname("hr"), null);
   241 		printTextElement(qname("h2"), null, "Result set #" + resultSetCounter);
   242 	}
   243 
   244 	@Override
   245 	public void writeEndResultSet() {
   246 		super.writeEndResultSet();
   247 		printEndElement();
   248 		printEndElement();
   249 
   250 		printTextElement(qname("p"), null, "Record count: " + getCurrentRowCount());
   251 	}
   252 
   253 	@Override
   254 	public void writeStartUpdatesResult() {
   255 		super.writeStartUpdatesResult();
   256 		updatesResultCounter++;
   257 		printEmptyElement(qname("hr"), null);
   258 		printTextElement(qname("h2"), null, "Updates result #" + updatesResultCounter);
   259 	}
   260 
   261 	@Override
   262 	public void writeUpdatedRowsCount(int updatedRowsCount) {
   263 		super.writeUpdatedRowsCount(updatedRowsCount);
   264 		printTextElement(qname("p"), null, "Updated rows: " + updatedRowsCount);
   265 	}
   266 }