KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > freemarker > core > NodeBuiltins


1 /*
2  * Copyright (c) 2003 The Visigoth Software Society. All rights
3  * reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * 2. Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in
14  * the documentation and/or other materials provided with the
15  * distribution.
16  *
17  * 3. The end-user documentation included with the redistribution, if
18  * any, must include the following acknowledgement:
19  * "This product includes software developed by the
20  * Visigoth Software Society (http://www.visigoths.org/)."
21  * Alternately, this acknowledgement may appear in the software itself,
22  * if and wherever such third-party acknowledgements normally appear.
23  *
24  * 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
25  * project contributors may be used to endorse or promote products derived
26  * from this software without prior written permission. For written
27  * permission, please contact visigoths@visigoths.org.
28  *
29  * 5. Products derived from this software may not be called "FreeMarker" or "Visigoth"
30  * nor may "FreeMarker" or "Visigoth" appear in their names
31  * without prior written permission of the Visigoth Software Society.
32  *
33  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
34  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
35  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
36  * DISCLAIMED. IN NO EVENT SHALL THE VISIGOTH SOFTWARE SOCIETY OR
37  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
38  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
39  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
40  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
41  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
42  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
44  * SUCH DAMAGE.
45  * ====================================================================
46  *
47  * This software consists of voluntary contributions made by many
48  * individuals on behalf of the Visigoth Software Society. For more
49  * information on the Visigoth Software Society, please see
50  * http://www.visigoths.org/
51  */

52
53 package freemarker.core;
54
55 import freemarker.template.*;
56 import freemarker.template.utility.StringUtil;
57 import java.util.List JavaDoc;
58
59 /**
60  * A holder for builtins that operate on TemplateNodeModels.
61  */

62
63 abstract class NodeBuiltins {
64     
65     abstract static class NodeBuiltIn extends BuiltIn {
66         TemplateModel _getAsTemplateModel(Environment env)
67                 throws TemplateException
68         {
69             TemplateModel model = target.getAsTemplateModel(env);
70             if (!(model instanceof TemplateNodeModel)) {
71                 throw invalidTypeException(model, target, env, "node model");
72             }
73             return calculateResult((TemplateNodeModel) model, env);
74         }
75         abstract TemplateModel calculateResult(TemplateNodeModel nodeModel, Environment env)
76                 throws TemplateModelException;
77     }
78
79     static class ancestorsBI extends NodeBuiltIn {
80        TemplateModel calculateResult(TemplateNodeModel nodeModel, Environment env) throws TemplateModelException {
81            AncestorSequence result = new AncestorSequence(env);
82            TemplateNodeModel parent = nodeModel.getParentNode();
83            while (parent != null) {
84                result.add(parent);
85                parent = parent.getParentNode();
86            }
87            return result;
88        }
89     }
90     
91     static class childrenBI extends NodeBuiltIn {
92        TemplateModel calculateResult(TemplateNodeModel nodeModel, Environment env) throws TemplateModelException {
93             return nodeModel.getChildNodes();
94        }
95     }
96     
97     
98     static class node_nameBI extends NodeBuiltIn {
99        TemplateModel calculateResult(TemplateNodeModel nodeModel, Environment env) throws TemplateModelException {
100             return new SimpleScalar(nodeModel.getNodeName());
101        }
102     }
103     
104     static class node_typeBI extends NodeBuiltIn {
105        TemplateModel calculateResult(TemplateNodeModel nodeModel, Environment env) throws TemplateModelException {
106             return new SimpleScalar(nodeModel.getNodeType());
107         }
108     }
109
110     static class parentBI extends NodeBuiltIn {
111        TemplateModel calculateResult(TemplateNodeModel nodeModel, Environment env) throws TemplateModelException {
112             return nodeModel.getParentNode();
113        }
114     }
115     
116     static class rootBI extends NodeBuiltIn {
117        TemplateModel calculateResult(TemplateNodeModel nodeModel, Environment env) throws TemplateModelException {
118             TemplateNodeModel result = nodeModel;
119             TemplateNodeModel parent = nodeModel.getParentNode();
120             while (parent != null) {
121                 result = parent;
122                 parent = result.getParentNode();
123             }
124             return result;
125        }
126     }
127     
128     static class node_namespaceBI extends NodeBuiltIn {
129         TemplateModel calculateResult(TemplateNodeModel nodeModel, Environment env) throws TemplateModelException {
130             String JavaDoc nsURI = nodeModel.getNodeNamespace();
131             return nsURI == null ? null : new SimpleScalar(nsURI);
132         }
133     }
134     
135     
136     static class AncestorSequence extends SimpleSequence implements TemplateMethodModel {
137         
138         private Environment env;
139         
140         AncestorSequence(Environment env) {
141             this.env = env;
142         }
143         
144         public Object JavaDoc exec(List JavaDoc names) throws TemplateModelException {
145             if (names == null || names.isEmpty()) {
146                 return this;
147             }
148             AncestorSequence result = new AncestorSequence(env);
149             for (int i=0; i<size(); i++) {
150                 TemplateNodeModel tnm = (TemplateNodeModel) get(i);
151                 String JavaDoc nodeName = tnm.getNodeName();
152                 String JavaDoc nsURI = tnm.getNodeNamespace();
153                 if (nsURI == null) {
154                     if (names.contains(nodeName)) {
155                         result.add(tnm);
156                     }
157                 } else {
158                     for (int j = 0; j<names.size(); j++) {
159                         if (StringUtil.matchesName((String JavaDoc) names.get(j), nodeName, nsURI, env)) {
160                             result.add(tnm);
161                             break;
162                         }
163                     }
164                 }
165             }
166             return result;
167         }
168     }
169 }
Popular Tags