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.formatting.AbstractXmlFormatter.qname;
24 import static info.globalcode.sql.dk.Functions.notNull;
25 import info.globalcode.sql.dk.NamedParameter;
26 import java.util.LinkedHashMap;
27 import java.util.List;
29 import javax.xml.namespace.QName;
32 * <p>Prints machine-readable output – XML document containing resultsets and updates count. Good
33 * choice for further processing – e.g. XSL transformation.</p>
37 * @author Ing. František Kučera (frantovo.cz)
39 public class XmlFormatter extends AbstractXmlFormatter {
41 public static final String NAME = "xml"; // bash-completion:formatter
42 public static final String PROPERTY_LABELED_COLUMNS = "labeledColumns";
43 private final boolean labeledColumns;
45 public XmlFormatter(FormatterContext formatterContext) {
46 super(formatterContext);
47 labeledColumns = formatterContext.getProperties().getBoolean(PROPERTY_LABELED_COLUMNS, false);
51 public void writeStartBatch() {
52 super.writeStartBatch();
54 printStartElement(qname("batchResult"), singleAttribute(qname("xmlns"), Xmlns.BATCH_RESULT));
58 public void writeEndBatch() {
59 super.writeEndBatch();
65 public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
66 super.writeStartDatabase(databaseDefinition);
67 Map<QName, String> attributes = databaseDefinition.getName() == null ? null : singleAttribute(qname("name"), databaseDefinition.getName());
68 printStartElement(qname("database"), attributes);
72 public void writeEndDatabase() {
73 super.writeEndDatabase();
78 public void writeStartStatement() {
79 super.writeStartStatement();
80 printStartElement(qname("statement"));
84 public void writeEndStatement() {
85 super.writeEndStatement();
90 public void writeQuery(String sql) {
91 super.writeQuery(sql);
92 printTextElement(qname("sql"), null, sql);
96 public void writeParameters(List<? extends Parameter> parameters) {
97 super.writeParameters(parameters);
99 for (Parameter p : notNull(parameters)) {
101 Map<QName, String> attributes = new LinkedHashMap<>(2);
102 if (p instanceof NamedParameter) {
103 attributes.put(qname("name"), ((NamedParameter) p).getName());
105 attributes.put(qname("type"), p.getType().name());
107 printTextElement(qname("parameter"), attributes, String.valueOf(p.getValue()));
113 public void writeStartResultSet(ColumnsHeader header) {
114 super.writeStartResultSet(header);
115 printStartElement(qname("resultSet"));
117 for (ColumnDescriptor cd : header.getColumnDescriptors()) {
118 Map<QName, String> attributes = new LinkedHashMap<>(4);
119 attributes.put(qname("label"), cd.getLabel());
120 attributes.put(qname("name"), cd.getName());
121 attributes.put(qname("typeName"), cd.getTypeName());
122 attributes.put(qname("type"), String.valueOf(cd.getType()));
123 printEmptyElement(qname("columnHeader"), attributes);
128 public void writeEndResultSet() {
129 super.writeEndResultSet();
134 public void writeStartRow() {
135 super.writeStartRow();
136 printStartElement(qname("row"));
140 public void writeColumnValue(Object value) {
141 super.writeColumnValue(value);
143 Map<QName, String> attributes = null;
144 if (labeledColumns) {
145 attributes = new LinkedHashMap<>(2);
146 attributes.put(qname("label"), getCurrentColumnsHeader().getColumnDescriptors().get(getCurrentColumnsCount() - 1).getLabel());
150 if (attributes == null) {
151 attributes = new LinkedHashMap<>(2);
152 attributes.put(qname("null"), "true");
153 printEmptyElement(qname("column"), attributes);
156 printTextElement(qname("column"), attributes, toString(value));
161 public void writeEndRow() {
167 public void writeUpdatesResult(int updatedRowsCount) {
168 super.writeUpdatesResult(updatedRowsCount);
169 printTextElement(qname("updatedRows"), null, String.valueOf(updatedRowsCount));
172 protected String toString(Object value) {
173 return String.valueOf(value);