org.intermine.webservice.server.output.XMLFormatter.java Source code

Introduction

Here is the source code for org.intermine.webservice.server.output.XMLFormatter.java

Source

package org.intermine.webservice.server.output;

/*
 * Copyright (C) 2002-2013 FlyMine
 *
 * This code may be freely distributed and modified under the
 * terms of the GNU Lesser General Public Licence.  This should
 * be distributed with the code.  See the LICENSE file for more
 * information or http://www.gnu.org/copyleft/lesser.html.
 *
 */

import java.util.List;
import java.util.Map;
import java.util.Stack;

import org.apache.commons.lang.StringEscapeUtils;
import org.intermine.webservice.server.StatusDictionary;

/**
 * Formats data to XML format.
 * @author Jakub Kulaviak
 **/
public class XMLFormatter extends Formatter {

    private final Stack<String> openElements = new Stack<String>();

    protected String getRootElement() {
        return "ResultSet";
    }

    protected String getRowElement() {
        return "Result";
    }

    protected String getItemElement() {
        return "i";
    }

    protected String getErrorElement() {
        return "error";
    }

    protected String getMessageElement() {
        return "message";
    }

    protected String getCauseElement() {
        return "cause";
    }

    /** {@inheritDoc}} **/
    @SuppressWarnings("rawtypes")
    @Override
    public String formatHeader(Map<String, Object> attributes) {
        StringBuilder sb = new StringBuilder();
        sb.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
        String elem = getRootElement();
        openElements.push(elem);
        sb.append("<" + elem + " ");
        handleHeaderAttributes(attributes, sb);
        return sb.toString();
    }

    protected void handleHeaderAttributes(Map<String, Object> attributes, StringBuilder sb) {
        if (attributes != null) {
            for (String key : attributes.keySet()) {
                if (attributes.get(key) instanceof Map) {
                    for (Object subK : ((Map) attributes.get(key)).keySet()) {
                        sb.append(subK + "=\"" + ((Map) attributes.get(key)).get(subK) + "\" ");
                    }
                } else {
                    sb.append(key + "=\"" + attributes.get(key) + "\" ");
                }
            }
        }
        sb.append(">");
    }

    /** {@inheritDoc}} **/
    @Override
    public String formatResult(List<String> resultRow) {
        StringBuilder sb = new StringBuilder();
        String elem = getRowElement();
        sb.append("<" + elem + ">");
        openElements.push(elem);
        for (String s : resultRow) {
            addElement(sb, getItemElement(), s);
        }
        sb.append("</" + elem + ">");
        openElements.pop();
        return sb.toString();
    }

    protected void addElement(StringBuilder sb, String tag, String contents) {
        sb.append("<" + tag + ">");
        openElements.push(tag);
        sb.append(StringEscapeUtils.escapeXml(contents));
        sb.append("</" + openElements.pop() + ">");
    }

    /** {@inheritDoc}} **/
    @Override
    public String formatFooter(String errorMessage, int errorCode) {

        StringBuilder sb = new StringBuilder();
        // Close all the open tags, except for ResultSet
        if (openElements.isEmpty()) {
            sb.append("<" + getRootElement() + ">"); //return a result set, even on failure
        }
        while (!openElements.isEmpty()) {
            String openTag = openElements.pop();
            if (getRootElement().equals(openTag)) {
                continue;
            }
            sb.append("</" + openTag + ">");
        }
        if (errorCode != Output.SC_OK) {
            sb.append("<" + getErrorElement() + ">");
            addElement(sb, getMessageElement(), StatusDictionary.getDescription(errorCode));
            addElement(sb, getCauseElement(), errorMessage);
            sb.append("</" + getErrorElement() + ">");
        }
        sb.append("</" + getRootElement() + ">");
        return sb.toString();
    }
}