java/sql-dk/src/info/globalcode/sql/dk/formatting/XmlFormatter.java
author František Kučera <franta-hg@frantovo.cz>
Sat, 04 Jan 2014 20:24:27 +0100
branchv_0
changeset 131 347a7dd94a3f
parent 129 331634456bf8
child 134 f2510551b5bf
permissions -rw-r--r--
XML formatter: optional label attribute in column elements
franta-hg@29
     1
/**
franta-hg@29
     2
 * SQL-DK
franta-hg@29
     3
 * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@29
     4
 *
franta-hg@29
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@29
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@29
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@29
     8
 * (at your option) any later version.
franta-hg@29
     9
 *
franta-hg@29
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@29
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@29
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@29
    13
 * GNU General Public License for more details.
franta-hg@29
    14
 *
franta-hg@29
    15
 * You should have received a copy of the GNU General Public License
franta-hg@29
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@29
    17
 */
franta-hg@29
    18
package info.globalcode.sql.dk.formatting;
franta-hg@29
    19
franta-hg@128
    20
import info.globalcode.sql.dk.Parameter;
franta-hg@128
    21
import info.globalcode.sql.dk.Xmlns;
franta-hg@128
    22
import info.globalcode.sql.dk.configuration.DatabaseDefinition;
franta-hg@128
    23
import static info.globalcode.sql.dk.formatting.AbstractXmlFormatter.qname;
franta-hg@128
    24
import static info.globalcode.sql.dk.Functions.notNull;
franta-hg@128
    25
import info.globalcode.sql.dk.NamedParameter;
franta-hg@128
    26
import java.util.LinkedHashMap;
franta-hg@128
    27
import java.util.List;
franta-hg@128
    28
import java.util.Map;
franta-hg@128
    29
import javax.xml.namespace.QName;
franta-hg@128
    30
franta-hg@29
    31
/**
franta-hg@29
    32
 *
franta-hg@29
    33
 * @author Ing. František Kučera (frantovo.cz)
franta-hg@29
    34
 */
franta-hg@128
    35
public class XmlFormatter extends AbstractXmlFormatter {
franta-hg@29
    36
franta-hg@79
    37
	public static final String NAME = "xml"; // bash-completion:formatter
franta-hg@131
    38
	public static final String PROPERTY_LABELED_COLUMNS = "labeledColumns";
franta-hg@131
    39
	private final boolean labeledColumns;
franta-hg@29
    40
franta-hg@29
    41
	public XmlFormatter(FormatterContext formatterContext) {
franta-hg@29
    42
		super(formatterContext);
franta-hg@131
    43
		labeledColumns = formatterContext.getProperties().getBoolean(PROPERTY_LABELED_COLUMNS, false);
franta-hg@29
    44
	}
franta-hg@128
    45
franta-hg@128
    46
	@Override
franta-hg@128
    47
	public void writeStartBatch() {
franta-hg@128
    48
		super.writeStartBatch();
franta-hg@128
    49
		printStartDocument();
franta-hg@128
    50
		printStartElement(qname("batchResults"), singleAttribute(qname("xmlns"), Xmlns.BATCH_RESULT));
franta-hg@128
    51
	}
franta-hg@128
    52
franta-hg@128
    53
	@Override
franta-hg@128
    54
	public void writeEndBatch() {
franta-hg@128
    55
		super.writeEndBatch();
franta-hg@128
    56
franta-hg@128
    57
		printEndElement();
franta-hg@128
    58
		printEndDocument();
franta-hg@128
    59
	}
franta-hg@128
    60
franta-hg@128
    61
	@Override
franta-hg@128
    62
	public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
franta-hg@128
    63
		super.writeStartDatabase(databaseDefinition);
franta-hg@128
    64
		Map<QName, String> attributes = databaseDefinition.getName() == null ? null : singleAttribute(qname("name"), databaseDefinition.getName());
franta-hg@128
    65
		printStartElement(qname("database"), attributes);
franta-hg@128
    66
	}
franta-hg@128
    67
franta-hg@128
    68
	@Override
franta-hg@128
    69
	public void writeEndDatabase() {
franta-hg@128
    70
		super.writeEndDatabase();
franta-hg@128
    71
		printEndElement();
franta-hg@128
    72
	}
franta-hg@128
    73
franta-hg@128
    74
	@Override
franta-hg@128
    75
	public void writeStartResultSet() {
franta-hg@128
    76
		super.writeStartResultSet();
franta-hg@128
    77
		printStartElement(qname("resultSet"));
franta-hg@128
    78
	}
franta-hg@128
    79
franta-hg@128
    80
	@Override
franta-hg@128
    81
	public void writeEndResultSet() {
franta-hg@128
    82
		super.writeEndResultSet();
franta-hg@128
    83
		printEndElement();
franta-hg@128
    84
	}
franta-hg@128
    85
franta-hg@128
    86
	@Override
franta-hg@128
    87
	public void writeQuery(String sql) {
franta-hg@128
    88
		super.writeQuery(sql);
franta-hg@128
    89
		printTextElement(qname("sql"), null, sql);
franta-hg@128
    90
	}
franta-hg@128
    91
franta-hg@128
    92
	@Override
franta-hg@128
    93
	public void writeParameters(List<? extends Parameter> parameters) {
franta-hg@128
    94
		super.writeParameters(parameters);
franta-hg@128
    95
franta-hg@128
    96
		for (Parameter p : notNull(parameters)) {
franta-hg@128
    97
franta-hg@128
    98
			Map<QName, String> attributes = new LinkedHashMap<>(2);
franta-hg@128
    99
			if (p instanceof NamedParameter) {
franta-hg@128
   100
				attributes.put(qname("name"), ((NamedParameter) p).getName());
franta-hg@128
   101
			}
franta-hg@128
   102
			attributes.put(qname("type"), p.getType().name());
franta-hg@128
   103
franta-hg@128
   104
			printTextElement(qname("parameter"), attributes, String.valueOf(p.getValue()));
franta-hg@128
   105
		}
franta-hg@128
   106
franta-hg@128
   107
	}
franta-hg@128
   108
franta-hg@128
   109
	@Override
franta-hg@128
   110
	public void writeColumnsHeader(ColumnsHeader header) {
franta-hg@128
   111
		super.writeColumnsHeader(header);
franta-hg@128
   112
franta-hg@128
   113
		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
franta-hg@128
   114
			Map<QName, String> attributes = new LinkedHashMap<>(4);
franta-hg@128
   115
			attributes.put(qname("label"), cd.getLabel());
franta-hg@128
   116
			attributes.put(qname("name"), cd.getName());
franta-hg@128
   117
			attributes.put(qname("typeName"), cd.getTypeName());
franta-hg@128
   118
			attributes.put(qname("type"), String.valueOf(cd.getType()));
franta-hg@128
   119
			printEmptyElement(qname("columnHeader"), attributes);
franta-hg@128
   120
		}
franta-hg@128
   121
	}
franta-hg@129
   122
franta-hg@129
   123
	@Override
franta-hg@129
   124
	public void writeStartRow() {
franta-hg@129
   125
		super.writeStartRow();
franta-hg@129
   126
		printStartElement(qname("row"));
franta-hg@129
   127
	}
franta-hg@129
   128
franta-hg@129
   129
	@Override
franta-hg@129
   130
	public void writeColumnValue(Object value) {
franta-hg@129
   131
		super.writeColumnValue(value);
franta-hg@131
   132
franta-hg@131
   133
		Map<QName, String> attributes = null;
franta-hg@131
   134
		if (labeledColumns) {
franta-hg@131
   135
			attributes = new LinkedHashMap<>(1);
franta-hg@131
   136
			attributes.put(qname("label"), getCurrentColumnsHeader().getColumnDescriptors().get(getCurrentColumnsCount() - 1).getLabel());
franta-hg@131
   137
		}
franta-hg@131
   138
franta-hg@131
   139
		printTextElement(qname("column"), attributes, toString(value));
franta-hg@129
   140
	}
franta-hg@129
   141
franta-hg@129
   142
	@Override
franta-hg@129
   143
	public void writeEndRow() {
franta-hg@129
   144
		super.writeEndRow();
franta-hg@129
   145
		printEndElement();
franta-hg@129
   146
	}
franta-hg@129
   147
franta-hg@129
   148
	@Override
franta-hg@129
   149
	public void writeStartUpdatesResult() {
franta-hg@129
   150
		super.writeStartUpdatesResult();
franta-hg@129
   151
		printStartElement(qname("updatesResult"));
franta-hg@129
   152
	}
franta-hg@129
   153
franta-hg@129
   154
	@Override
franta-hg@129
   155
	public void writeUpdatedRowsCount(int updatedRowsCount) {
franta-hg@129
   156
		super.writeUpdatedRowsCount(updatedRowsCount);
franta-hg@129
   157
		printTextElement(qname("updatedRows"), null, String.valueOf(updatedRowsCount));
franta-hg@129
   158
	}
franta-hg@129
   159
franta-hg@129
   160
	@Override
franta-hg@129
   161
	public void writeEndUpdatesResult() {
franta-hg@129
   162
		super.writeEndUpdatesResult();
franta-hg@129
   163
		printEndElement();
franta-hg@129
   164
	}
franta-hg@129
   165
franta-hg@129
   166
	protected String toString(Object value) {
franta-hg@129
   167
		return String.valueOf(value);
franta-hg@129
   168
	}
franta-hg@29
   169
}