franta-hg@29: /**
franta-hg@29:  * SQL-DK
franta-hg@29:  * Copyright © 2013 František Kučera (frantovo.cz)
franta-hg@29:  *
franta-hg@29:  * This program is free software: you can redistribute it and/or modify
franta-hg@29:  * it under the terms of the GNU General Public License as published by
franta-hg@29:  * the Free Software Foundation, either version 3 of the License, or
franta-hg@29:  * (at your option) any later version.
franta-hg@29:  *
franta-hg@29:  * This program is distributed in the hope that it will be useful,
franta-hg@29:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@29:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@29:  * GNU General Public License for more details.
franta-hg@29:  *
franta-hg@29:  * You should have received a copy of the GNU General Public License
franta-hg@29:  * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@29:  */
franta-hg@29: package info.globalcode.sql.dk.formatting;
franta-hg@29: 
franta-hg@128: import info.globalcode.sql.dk.Parameter;
franta-hg@128: import info.globalcode.sql.dk.Xmlns;
franta-hg@128: import info.globalcode.sql.dk.configuration.DatabaseDefinition;
franta-hg@128: import static info.globalcode.sql.dk.formatting.AbstractXmlFormatter.qname;
franta-hg@128: import static info.globalcode.sql.dk.Functions.notNull;
franta-hg@128: import info.globalcode.sql.dk.NamedParameter;
franta-hg@128: import java.util.LinkedHashMap;
franta-hg@128: import java.util.List;
franta-hg@128: import java.util.Map;
franta-hg@128: import javax.xml.namespace.QName;
franta-hg@128: 
franta-hg@29: /**
franta-hg@29:  *
franta-hg@29:  * @author Ing. František Kučera (frantovo.cz)
franta-hg@29:  */
franta-hg@128: public class XmlFormatter extends AbstractXmlFormatter {
franta-hg@29: 
franta-hg@79: 	public static final String NAME = "xml"; // bash-completion:formatter
franta-hg@131: 	public static final String PROPERTY_LABELED_COLUMNS = "labeledColumns";
franta-hg@131: 	private final boolean labeledColumns;
franta-hg@29: 
franta-hg@29: 	public XmlFormatter(FormatterContext formatterContext) {
franta-hg@29: 		super(formatterContext);
franta-hg@131: 		labeledColumns = formatterContext.getProperties().getBoolean(PROPERTY_LABELED_COLUMNS, false);
franta-hg@29: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeStartBatch() {
franta-hg@128: 		super.writeStartBatch();
franta-hg@128: 		printStartDocument();
franta-hg@128: 		printStartElement(qname("batchResults"), singleAttribute(qname("xmlns"), Xmlns.BATCH_RESULT));
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeEndBatch() {
franta-hg@128: 		super.writeEndBatch();
franta-hg@128: 		printEndElement();
franta-hg@128: 		printEndDocument();
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeStartDatabase(DatabaseDefinition databaseDefinition) {
franta-hg@128: 		super.writeStartDatabase(databaseDefinition);
franta-hg@128: 		Map<QName, String> attributes = databaseDefinition.getName() == null ? null : singleAttribute(qname("name"), databaseDefinition.getName());
franta-hg@128: 		printStartElement(qname("database"), attributes);
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeEndDatabase() {
franta-hg@128: 		super.writeEndDatabase();
franta-hg@128: 		printEndElement();
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeStartResultSet() {
franta-hg@128: 		super.writeStartResultSet();
franta-hg@128: 		printStartElement(qname("resultSet"));
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeEndResultSet() {
franta-hg@128: 		super.writeEndResultSet();
franta-hg@128: 		printEndElement();
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeQuery(String sql) {
franta-hg@128: 		super.writeQuery(sql);
franta-hg@128: 		printTextElement(qname("sql"), null, sql);
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeParameters(List<? extends Parameter> parameters) {
franta-hg@128: 		super.writeParameters(parameters);
franta-hg@128: 
franta-hg@128: 		for (Parameter p : notNull(parameters)) {
franta-hg@128: 
franta-hg@128: 			Map<QName, String> attributes = new LinkedHashMap<>(2);
franta-hg@128: 			if (p instanceof NamedParameter) {
franta-hg@128: 				attributes.put(qname("name"), ((NamedParameter) p).getName());
franta-hg@128: 			}
franta-hg@128: 			attributes.put(qname("type"), p.getType().name());
franta-hg@128: 
franta-hg@128: 			printTextElement(qname("parameter"), attributes, String.valueOf(p.getValue()));
franta-hg@128: 		}
franta-hg@128: 
franta-hg@128: 	}
franta-hg@128: 
franta-hg@128: 	@Override
franta-hg@128: 	public void writeColumnsHeader(ColumnsHeader header) {
franta-hg@128: 		super.writeColumnsHeader(header);
franta-hg@128: 
franta-hg@128: 		for (ColumnDescriptor cd : header.getColumnDescriptors()) {
franta-hg@128: 			Map<QName, String> attributes = new LinkedHashMap<>(4);
franta-hg@128: 			attributes.put(qname("label"), cd.getLabel());
franta-hg@128: 			attributes.put(qname("name"), cd.getName());
franta-hg@128: 			attributes.put(qname("typeName"), cd.getTypeName());
franta-hg@128: 			attributes.put(qname("type"), String.valueOf(cd.getType()));
franta-hg@128: 			printEmptyElement(qname("columnHeader"), attributes);
franta-hg@128: 		}
franta-hg@128: 	}
franta-hg@129: 
franta-hg@129: 	@Override
franta-hg@129: 	public void writeStartRow() {
franta-hg@129: 		super.writeStartRow();
franta-hg@129: 		printStartElement(qname("row"));
franta-hg@129: 	}
franta-hg@129: 
franta-hg@129: 	@Override
franta-hg@129: 	public void writeColumnValue(Object value) {
franta-hg@129: 		super.writeColumnValue(value);
franta-hg@131: 
franta-hg@131: 		Map<QName, String> attributes = null;
franta-hg@131: 		if (labeledColumns) {
franta-hg@131: 			attributes = new LinkedHashMap<>(1);
franta-hg@131: 			attributes.put(qname("label"), getCurrentColumnsHeader().getColumnDescriptors().get(getCurrentColumnsCount() - 1).getLabel());
franta-hg@131: 		}
franta-hg@131: 
franta-hg@131: 		printTextElement(qname("column"), attributes, toString(value));
franta-hg@129: 	}
franta-hg@129: 
franta-hg@129: 	@Override
franta-hg@129: 	public void writeEndRow() {
franta-hg@129: 		super.writeEndRow();
franta-hg@129: 		printEndElement();
franta-hg@129: 	}
franta-hg@129: 
franta-hg@129: 	@Override
franta-hg@129: 	public void writeStartUpdatesResult() {
franta-hg@129: 		super.writeStartUpdatesResult();
franta-hg@129: 		printStartElement(qname("updatesResult"));
franta-hg@129: 	}
franta-hg@129: 
franta-hg@129: 	@Override
franta-hg@129: 	public void writeUpdatedRowsCount(int updatedRowsCount) {
franta-hg@129: 		super.writeUpdatedRowsCount(updatedRowsCount);
franta-hg@129: 		printTextElement(qname("updatedRows"), null, String.valueOf(updatedRowsCount));
franta-hg@129: 	}
franta-hg@129: 
franta-hg@129: 	@Override
franta-hg@129: 	public void writeEndUpdatesResult() {
franta-hg@129: 		super.writeEndUpdatesResult();
franta-hg@129: 		printEndElement();
franta-hg@129: 	}
franta-hg@129: 
franta-hg@129: 	protected String toString(Object value) {
franta-hg@129: 		return String.valueOf(value);
franta-hg@129: 	}
franta-hg@29: }