support custom relation names in the XML formatter (added --relation CLI option)
3 * Copyright © 2013 František Kučera (frantovo.cz)
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.
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.
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/>.
18 package info.globalcode.sql.dk.formatting;
20 import info.globalcode.sql.dk.Parameter;
21 import info.globalcode.sql.dk.Xmlns;
22 import info.globalcode.sql.dk.configuration.DatabaseDefinition;
23 import static info.globalcode.sql.dk.Functions.notNull;
24 import info.globalcode.sql.dk.NamedParameter;
25 import info.globalcode.sql.dk.configuration.PropertyDeclaration;
26 import java.sql.Array;
27 import java.sql.ResultSet;
28 import java.sql.SQLException;
29 import java.sql.SQLXML;
30 import java.sql.Types;
31 import java.util.ArrayList;
32 import java.util.Collections;
33 import java.util.HashMap;
34 import java.util.LinkedHashMap;
35 import java.util.List;
37 import java.util.logging.Level;
38 import java.util.logging.Logger;
39 import javax.xml.namespace.QName;
43 * Prints machine-readable output – XML document containing resultsets and updates count. Good
44 * choice for further processing – e.g. XSL transformation.</p>
47 * XML format is defined in the <a href="https://relational-pipes.globalcode.info/">Relational
48 * pipes</a> specification.
51 * @author Ing. František Kučera (frantovo.cz)
53 @PropertyDeclaration(name = XmlFormatter.PROPERTY_LABELED_COLUMNS, defaultValue = "false", type = Boolean.class, description = "whether to add 'label' attribute to each 'column' element")
54 public class XmlFormatter extends AbstractXmlFormatter {
56 private static final String XML_ELEMENT_RELATION = "relation";
57 private static final String XML_ELEMENT_NAME = "name";
58 private static final String XML_ELEMENT_RECORD = "record";
59 private static final String XML_ELEMENT_ATTRIBUTE = "attribute";
60 private static final String XML_ATTRIBUTE_NAME = "name";
61 private static final String XML_ATTRIBUTE_TYPE = "type";
62 private static final String XML_ATTRIBUTE_STATEMENT = "statement";
63 private static final String XML_NS_PREFIX_SQLDK = "sql-dk";
65 private static final String RELPIPE_TYPE_BOOLEAN = "boolean";
66 private static final String RELPIPE_TYPE_INTEGER = "integer";
67 private static final String RELPIPE_TYPE_STRING = "string";
68 private static final Map<Integer, String> RELPIPE_TYPES;
71 Map<Integer, String> m = new HashMap<>();
72 m.put(Types.BOOLEAN, RELPIPE_TYPE_BOOLEAN);
73 m.put(Types.BIT, RELPIPE_TYPE_BOOLEAN); // TODO: relpipe "boolean" can not be null in the current version
74 // m.put(Types.INTEGER, RELPIPE_TYPE_INTEGER); // relpipe "integer" is unsigned
75 // TODO: add more types when supported in Relational pipes
76 m.put(Types.CHAR, RELPIPE_TYPE_STRING);
77 m.put(Types.VARCHAR, RELPIPE_TYPE_STRING);
78 RELPIPE_TYPES = Collections.unmodifiableMap(m);
81 public static final String NAME = "xml"; // bash-completion:formatter
82 public static final String PROPERTY_LABELED_COLUMNS = "labeledColumns";
83 private static final Logger log = Logger.getLogger(XmlFormatter.class.getName());
84 private final boolean labeledColumns;
86 private String currentDatabaseName;
87 private int statementCounter;
88 private int resultSetCounter;
90 public XmlFormatter(FormatterContext formatterContext) {
91 super(formatterContext);
92 labeledColumns = formatterContext.getProperties().getBoolean(PROPERTY_LABELED_COLUMNS, false);
95 private QName qname(String localPart) {
96 return new QName(Xmlns.RELPIPE, localPart);
99 private QName qnameDK(String localPart) {
100 return new QName(Xmlns.SQLDK, localPart, XML_NS_PREFIX_SQLDK);
104 public void writeStartBatch() {
105 super.writeStartBatch();
106 printStartDocument();
107 Map<QName, String> attributes = new LinkedHashMap<>(2);
108 attributes.put(qname("xmlns"), Xmlns.RELPIPE);
109 attributes.put(new QName(null, XML_NS_PREFIX_SQLDK, "xmlns"), Xmlns.SQLDK);
110 printStartElement(qname("relpipe"), attributes);
111 statementCounter = 0;
112 resultSetCounter = 0;
117 public void writeEndBatch() {
118 super.writeEndBatch();
124 public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
125 super.writeStartDatabase(databaseDefinition);
126 currentDatabaseName = databaseDefinition.getName();
127 Map<QName, String> attributes = databaseDefinition.getName() == null ? null : singleAttribute(qname("name"), databaseDefinition.getName());
128 printEmptyElement(qnameDK("database-start"), attributes);
132 public void writeEndDatabase() {
133 super.writeEndDatabase();
134 Map<QName, String> attributes = currentDatabaseName == null ? null : singleAttribute(qname("name"), currentDatabaseName);
135 printEmptyElement(qnameDK("database-end"), attributes);
138 private String getCurrentStatementName() {
139 return "s" + statementCounter;
143 public void writeStartStatement() {
144 super.writeStartStatement();
146 printEmptyElement(qnameDK("statement-start"), singleAttribute(qname("id"), getCurrentStatementName()));
150 public void writeEndStatement() {
151 super.writeEndStatement();
152 printEmptyElement(qnameDK("statement-end"), singleAttribute(qname("id"), getCurrentStatementName()));
156 public void writeQuery(String sql) {
157 super.writeQuery(sql);
158 printTextElement(qnameDK("sql"), singleAttribute(qname(XML_ATTRIBUTE_STATEMENT), getCurrentStatementName()), sql);
162 public void writeParameters(List<? extends Parameter> parameters) {
163 super.writeParameters(parameters);
165 if (parameters != null && parameters.size() > 0) {
167 printStartElement(qnameDK("parameters"), singleAttribute(qname(XML_ATTRIBUTE_STATEMENT), getCurrentStatementName()));
169 for (Parameter p : notNull(parameters)) {
171 Map<QName, String> attributes = new LinkedHashMap<>(2);
172 if (p instanceof NamedParameter) {
173 attributes.put(qname(XML_ATTRIBUTE_NAME), ((NamedParameter) p).getName());
175 attributes.put(qname(XML_ATTRIBUTE_TYPE), p.getType().name());
177 printTextElement(qnameDK("parameter"), attributes, String.valueOf(p.getValue()));
186 private String getCurrentRelationName() {
187 if (getFormatterContext().getRelationNames() == null || getFormatterContext().getRelationNames().size() < resultSetCounter) {
188 return "r" + resultSetCounter;
190 return getFormatterContext().getRelationNames().get(resultSetCounter - 1);
195 public void writeStartResultSet(ColumnsHeader header) {
196 super.writeStartResultSet(header);
198 printStartElement(qname(XML_ELEMENT_RELATION), singleAttribute(qnameDK(XML_ATTRIBUTE_STATEMENT), getCurrentStatementName()));
199 printTextElement(qname(XML_ELEMENT_NAME), null, getCurrentRelationName());
201 printStartElement(qname("attributes-metadata"));
202 for (ColumnDescriptor cd : header.getColumnDescriptors()) {
203 Map<QName, String> attributes = new LinkedHashMap<>(6);
205 attributes.put(qname(XML_ATTRIBUTE_NAME), cd.getLabel());
206 attributes.put(qname(XML_ATTRIBUTE_TYPE), toRelpipeType(cd.getType()));
208 attributes.put(qnameDK("tableName"), cd.getTableName());
209 attributes.put(qnameDK("columnName"), cd.getName());
210 attributes.put(qnameDK("jdbcTypeName"), cd.getTypeName());
211 attributes.put(qnameDK("jdbcType"), String.valueOf(cd.getType()));
213 printEmptyElement(qname("attribute-metadata"), attributes);
219 * @param jdbcType value from {@linkplain Types}
222 private String toRelpipeType(int jdbcType) {
223 return RELPIPE_TYPES.getOrDefault(jdbcType, RELPIPE_TYPE_STRING);
227 public void writeEndResultSet() {
228 super.writeEndResultSet();
233 public void writeStartRow() {
234 super.writeStartRow();
235 printStartElement(qname(XML_ELEMENT_RECORD));
239 public void writeColumnValue(Object value) {
240 super.writeColumnValue(value);
242 Map<QName, String> attributes = null;
243 if (labeledColumns) {
244 attributes = new LinkedHashMap<>(2);
245 attributes.put(qname(XML_ATTRIBUTE_NAME), getCurrentColumnsHeader().getColumnDescriptors().get(getCurrentColumnsCount() - 1).getLabel());
246 attributes.put(qname(XML_ATTRIBUTE_TYPE), toRelpipeType(getCurrentColumnsHeader().getColumnDescriptors().get(getCurrentColumnsCount() - 1).getType()));
250 if (attributes == null) {
251 attributes = new LinkedHashMap<>(2);
253 // TODO: synchronize syntax with Relational pipes (after adding support of null values)
254 attributes.put(qnameDK("null"), "true");
255 printEmptyElement(qname(XML_ELEMENT_ATTRIBUTE), attributes);
256 } else if (value instanceof Array) {
258 Array sqlArray = (Array) value;
260 Object[] array = (Object[]) sqlArray.getArray();
261 printStartElement(qname(XML_ELEMENT_ATTRIBUTE), attributes);
264 } catch (SQLException e) {
265 // FIXME: rewrite array formatting, remember array mode, don't try sqlArray.getArray() again and again if it has failed
266 log.log(Level.SEVERE, "Unable to format array", e);
268 ResultSet arrayResultSet = sqlArray.getResultSet();
269 //int columnCount = arrayResultSet.getMetaData().getColumnCount();
270 ArrayList<Object> arrayList = new ArrayList<>();
271 while (arrayResultSet.next()) {
272 arrayList.add(arrayResultSet.getObject(2));
273 // for (int i = 1; i <= columnCount; i++) {
274 // log.log(Level.INFO, "Array column {0} = {1}", new Object[]{i, arrayResultSet.getObject(i)});
278 printStartElement(qname(XML_ELEMENT_ATTRIBUTE), attributes);
279 // FIXME: instanceof SQLXML, see below
280 printArray(arrayList.toArray());
283 } catch (SQLException e2) {
284 // FIXME: fix logging, error recovery
285 log.log(Level.SEVERE, "Second level fuck up !!!", e2);
288 writeColumnValue(String.valueOf(value));
291 } else if (value instanceof SQLXML) { // FIXME: move to separate method, to AbstractFormatter?
292 SQLXML xml = (SQLXML) value;
293 // TODO: parse DOM/SAX and transplant XML, don't escape (optional)
295 printTextElement(qname(XML_ELEMENT_ATTRIBUTE), attributes, xml.getString());
296 } catch (SQLException e) {
297 log.log(Level.SEVERE, "Unable to format XML", e);
298 writeColumnValue(String.valueOf(value));
301 printTextElement(qname(XML_ELEMENT_ATTRIBUTE), attributes, toString(value));
305 private void printArray(Object[] array) {
306 // TODO: synchronize array syntax with Relational pipes
307 printStartElement(qnameDK("array"));
308 for (Object o : array) {
309 if (o instanceof Object[]) {
310 printStartElement(qnameDK("item"));
311 printArray((Object[]) o);
314 printTextElement(qnameDK("item"), null, String.valueOf(o));
321 public void writeEndRow() {
327 public void writeUpdatesResult(int updatedRowsCount) {
328 super.writeUpdatesResult(updatedRowsCount);
329 printTextElement(qnameDK("updatedRecords"), singleAttribute(qnameDK(XML_ATTRIBUTE_STATEMENT), getCurrentStatementName()), String.valueOf(updatedRowsCount));
332 protected String toString(Object value) {
333 return String.valueOf(value);