/*
* Copyright (c) 2003 The Visigoth Software Society. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowledgement:
* "This product includes software developed by the
* Visigoth Software Society (http://www.visigoths.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
* project contributors may be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact visigoths@visigoths.org.
*
* 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
* nor may "FreeMarker" or "Visigoth" appear in their names
* without prior written permission of the Visigoth Software Society.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Visigoth Software Society. For more
* information on the Visigoth Software Society, please see
* http://www.visigoths.org/
*/
package freemarker.ext.dom;
import org.w3c.dom.*;
import freemarker.template.*;
import freemarker.template.utility.StringUtil;
import freemarker.core.Environment;
class ElementModel extends NodeModel implements TemplateScalarModel {
public ElementModel(Element element) {
super(element);
}
public boolean isEmpty() {
return false;
}
/**
* An Element node supports various hash keys.
* Any key that corresponds to the tag name of any child elements
* returns a sequence of those elements. The special key "*" returns
* all the element's direct children.
* The "**" key return all the element's descendants in the order they
* occur in the document.
* Any key starting with '@' is taken to be the name of an element attribute.
* The special key "@@" returns a hash of all the element's attributes.
* The special key "/" returns the root document node associated with this element.
*/
public TemplateModel get(String key) throws TemplateModelException {
if (key.equals("*")) {
NodeListModel ns = new NodeListModel(this);
TemplateSequenceModel children = getChildNodes();
for (int i=0;i < children.size();i++) {
NodeModel child = (NodeModel) children.get(i);
if (child.node.getNodeType() == Node.ELEMENT_NODE) {
ns.add(child);
}
}
return ns;
}
if (key.equals("**")) {
Element elem = (Element) node;
return new NodeListModel(elem.getElementsByTagName("*"), this);
}
if (key.startsWith("@")) {
if (key.equals("@@") || key.equals("@*")) {
return new NodeListModel(node.getAttributes(), this);
}
if (key.equals("@@start_tag")) {
NodeOutputter nodeOutputter = new NodeOutputter(node);
return new SimpleScalar(nodeOutputter.getOpeningTag((Element) node));
}
if (key.equals("@@end_tag")) {
NodeOutputter nodeOutputter = new NodeOutputter(node);
return new SimpleScalar(nodeOutputter.getClosingTag((Element) node));
}
if (key.equals("@@attributes_markup")) {
StringBuffer buf = new StringBuffer();
NodeOutputter nu = new NodeOutputter(node);
nu.outputContent(node.getAttributes(), buf);
return new SimpleScalar(buf.toString().trim());
}
if (StringUtil.isXMLID(key.substring(1))) {
Attr att = getAttribute(key.substring(1), Environment.getCurrentEnvironment());
if (att == null) {
return new NodeListModel(this);
}
return wrap(att);
}
}
if (StringUtil.isXMLID(key)) {
NodeListModel result = ((NodeListModel) getChildNodes()).filterByName(key);
if (result.size() == 1) {
return result.get(0);
}
return result;
}
return super.get(key);
}
public String getAsString() throws TemplateModelException {
NodeList nl = node.getChildNodes();
String result = "";
for (int i = 0; i<nl.getLength(); i++) {
Node child = nl.item(i);
int nodeType = child.getNodeType();
if (nodeType == Node.ELEMENT_NODE) {
String msg = "Only elements with no child elements can be processed as text."
+ "\nThis element with name \""
+ node.getNodeName()
+ "\" has a child element named: " + child.getNodeName();
throw new TemplateModelException(msg);
}
else if (nodeType == Node.TEXT_NODE || nodeType == Node.CDATA_SECTION_NODE) {
result += child.getNodeValue();
}
}
return result;
}
public String getNodeName() {
String result = node.getLocalName();
if (result == null || result.equals("")) {
result = node.getNodeName();
}
return result;
}
String getQualifiedName() {
String nodeName = getNodeName();
String nsURI = getNodeNamespace();
if (nsURI == null || nsURI.length() == 0) {
return nodeName;
}
Environment env = Environment.getCurrentEnvironment();
String defaultNS = env.getDefaultNS();
String prefix;
if (defaultNS != null && defaultNS.equals(nsURI)) {
prefix = Template.DEFAULT_NAMESPACE_PREFIX;
} else {
prefix = env.getPrefixForNamespace(nsURI);
}
if (prefix == null) {
return null; // We have no qualified name, because there is no prefix mapping
}
if (prefix.length() >0) {
prefix += ":";
}
return prefix + nodeName;
}
private Attr getAttribute(String qname, Environment env) {
Element element = (Element) node;
Attr result = element.getAttributeNode(qname);
if (result != null)
return result;
int colonIndex = qname.indexOf(':');
if (colonIndex >0) {
String prefix = qname.substring(0, colonIndex);
String uri;
if (prefix.equals(Template.DEFAULT_NAMESPACE_PREFIX)) {
uri = Environment.getCurrentEnvironment().getDefaultNS();
} else {
uri = Environment.getCurrentEnvironment().getNamespaceForPrefix(prefix);
}
String localName = qname.substring(1+colonIndex);
if (uri != null) {
result = element.getAttributeNodeNS(uri, localName);
}
}
return result;
}
boolean matchesName(String name, Environment env) {
return StringUtil.matchesName(name, getNodeName(), getNodeNamespace(), env);
}
}