java/sql-dk/src/info/globalcode/sql/dk/formatting/XmlFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Wed, 15 Jan 2014 22:22:45 +0100
branchv_0
changeset 163 1df10a9be6f4
parent 155 eb3676c6929b
child 165 871185e406b3
permissions -rw-r--r--
XML formatter: fix null column values
     1 /**
     2  * SQL-DK
     3  * Copyright © 2013 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.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;
    28 import java.util.Map;
    29 import javax.xml.namespace.QName;
    30 
    31 /**
    32  * <p>Prints machine-readable output – XML document containing resultsets and updates count. Good
    33  * choice for further processing – e.g. XSL transformation.</p>
    34  *
    35  * <p>TODO: XSD</p>
    36  *
    37  * @author Ing. František Kučera (frantovo.cz)
    38  */
    39 public class XmlFormatter extends AbstractXmlFormatter {
    40 
    41 	public static final String NAME = "xml"; // bash-completion:formatter
    42 	public static final String PROPERTY_LABELED_COLUMNS = "labeledColumns";
    43 	private final boolean labeledColumns;
    44 
    45 	public XmlFormatter(FormatterContext formatterContext) {
    46 		super(formatterContext);
    47 		labeledColumns = formatterContext.getProperties().getBoolean(PROPERTY_LABELED_COLUMNS, false);
    48 	}
    49 
    50 	@Override
    51 	public void writeStartBatch() {
    52 		super.writeStartBatch();
    53 		printStartDocument();
    54 		printStartElement(qname("batchResult"), singleAttribute(qname("xmlns"), Xmlns.BATCH_RESULT));
    55 	}
    56 
    57 	@Override
    58 	public void writeEndBatch() {
    59 		super.writeEndBatch();
    60 		printEndElement();
    61 		printEndDocument();
    62 	}
    63 
    64 	@Override
    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);
    69 	}
    70 
    71 	@Override
    72 	public void writeEndDatabase() {
    73 		super.writeEndDatabase();
    74 		printEndElement();
    75 	}
    76 
    77 	@Override
    78 	public void writeStartStatement() {
    79 		super.writeStartStatement();
    80 		printStartElement(qname("statement"));
    81 	}
    82 
    83 	@Override
    84 	public void writeEndStatement() {
    85 		super.writeEndStatement();
    86 		printEndElement();
    87 	}
    88 
    89 	@Override
    90 	public void writeQuery(String sql) {
    91 		super.writeQuery(sql);
    92 		printTextElement(qname("sql"), null, sql);
    93 	}
    94 
    95 	@Override
    96 	public void writeParameters(List<? extends Parameter> parameters) {
    97 		super.writeParameters(parameters);
    98 
    99 		for (Parameter p : notNull(parameters)) {
   100 
   101 			Map<QName, String> attributes = new LinkedHashMap<>(2);
   102 			if (p instanceof NamedParameter) {
   103 				attributes.put(qname("name"), ((NamedParameter) p).getName());
   104 			}
   105 			attributes.put(qname("type"), p.getType().name());
   106 
   107 			printTextElement(qname("parameter"), attributes, String.valueOf(p.getValue()));
   108 		}
   109 
   110 	}
   111 
   112 	@Override
   113 	public void writeStartResultSet(ColumnsHeader header) {
   114 		super.writeStartResultSet(header);
   115 		printStartElement(qname("resultSet"));
   116 
   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);
   124 		}
   125 	}
   126 
   127 	@Override
   128 	public void writeEndResultSet() {
   129 		super.writeEndResultSet();
   130 		printEndElement();
   131 	}
   132 
   133 	@Override
   134 	public void writeStartRow() {
   135 		super.writeStartRow();
   136 		printStartElement(qname("row"));
   137 	}
   138 
   139 	@Override
   140 	public void writeColumnValue(Object value) {
   141 		super.writeColumnValue(value);
   142 
   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());
   147 		}
   148 
   149 		if (value == null) {
   150 			if (attributes == null) {
   151 				attributes = new LinkedHashMap<>(2);
   152 			}
   153 			attributes.put(qname("null"), "true");
   154 			printEmptyElement(qname("column"), attributes);
   155 		} else {
   156 			printTextElement(qname("column"), attributes, toString(value));
   157 		}
   158 	}
   159 
   160 	@Override
   161 	public void writeEndRow() {
   162 		super.writeEndRow();
   163 		printEndElement();
   164 	}
   165 
   166 	@Override
   167 	public void writeUpdatesResult(int updatedRowsCount) {
   168 		super.writeUpdatesResult(updatedRowsCount);
   169 		printTextElement(qname("updatedRows"), null, String.valueOf(updatedRowsCount));
   170 	}
   171 
   172 	protected String toString(Object value) {
   173 		return String.valueOf(value);
   174 	}
   175 }