org.collectionspace.chain.util.xtmpl.XTmplTmpl.java Source code

Introduction

Here is the source code for org.collectionspace.chain.util.xtmpl.XTmplTmpl.java

Source

/* Copyright 2010 University of Cambridge
 * Licensed under the Educational Community License (ECL), Version 2.0. You may not use this file except in 
 * compliance with this License.
 *
 * You may obtain a copy of the ECL 2.0 License at https://source.collectionspace.org/collection-space/LICENSE.txt
 */
package org.collectionspace.chain.util.xtmpl;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.dom4j.Attribute;
import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.Namespace;
import org.dom4j.Node;
import org.dom4j.QName;
import org.jaxen.JaxenException;
import org.jaxen.SimpleNamespaceContext;
import org.jaxen.dom4j.Dom4jXPath;

/** An XML template which can generate XTmplDocument's to fill in.
 * 
 */
public class XTmplTmpl {
    private static final String XTMPL_URI = "http://www.collectionspace.org/xtmpl";

    private Map<String, String> attach = new HashMap<String, String>();
    private Document document;
    private boolean squash_empty = false;

    public static XTmplTmpl compile(Document template) throws InvalidXTmplException {
        return new XTmplTmpl(template);
    }

    private XTmplTmpl(Document template) throws InvalidXTmplException {
        compileTemplate(template);
    }

    public void setSquashEmpty(boolean sq) {
        squash_empty = sq;
    }

    @SuppressWarnings("unchecked")
    private void removeNamespaces(Element e) {
        for (Namespace ns : (List<Namespace>) e.declaredNamespaces()) {
            if (!XTMPL_URI.equals(ns.getURI()))
                continue;
            e.remove(ns);
        }
        for (Element k : (List<Element>) e.elements()) {
            removeNamespaces(k);
        }
    }

    @SuppressWarnings("unchecked")
    private void compileTemplate(Document template) throws InvalidXTmplException {
        try {
            Map<String, String> map = new HashMap<String, String>();
            map.put("xtmpl", XTMPL_URI);
            Dom4jXPath xpath = new Dom4jXPath("//.[@xtmpl:point]");
            xpath.setNamespaceContext(new SimpleNamespaceContext(map));
            List<Node> paths = xpath.selectNodes(template);
            QName attr_qname = new QName("point", new Namespace("xtmpl", XTMPL_URI));
            for (Node n : paths) {
                if (!(n instanceof Element))
                    continue;
                Element e = (Element) n;
                Attribute attr = e.attribute(attr_qname);
                String key = attr.getText();
                String path = e.getPath();
                e.remove(attr);
                attach.put(key, path);
            }
            removeNamespaces(template.getDocument().getRootElement());
            document = template;
        } catch (JaxenException e) {
            throw new InvalidXTmplException("Cannot parse template file", e);
        }
    }

    public XTmplDocument makeDocument() {
        return new XTmplDocument(document, attach, squash_empty);
    }
}