001: package org.apache.velocity.tools.view.servlet;
002:
003: /*
004: * Licensed to the Apache Software Foundation (ASF) under one
005: * or more contributor license agreements. See the NOTICE file
006: * distributed with this work for additional information
007: * regarding copyright ownership. The ASF licenses this file
008: * to you under the Apache License, Version 2.0 (the
009: * "License"); you may not use this file except in compliance
010: * with the License. You may obtain a copy of the License at
011: *
012: * http://www.apache.org/licenses/LICENSE-2.0
013: *
014: * Unless required by applicable law or agreed to in writing,
015: * software distributed under the License is distributed on an
016: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017: * KIND, either express or implied. See the License for the
018: * specific language governing permissions and limitations
019: * under the License.
020: */
021:
022: import org.apache.commons.digester.Digester;
023: import org.apache.commons.digester.Rule;
024: import org.apache.velocity.tools.view.ToolboxRuleSet;
025:
026: /**
027: * <p>The set of Digester rules required to parse a toolbox
028: * configuration file (<code>toolbox.xml</code>) for the
029: * ServletToolboxManager class.</p>
030: *
031: * @since VelocityTools 1.1
032: * @author Nathan Bubna
033: * @version $Id: ServletToolboxRuleSet.java 479724 2006-11-27 18:49:37Z nbubna $
034: */
035: public class ServletToolboxRuleSet extends ToolboxRuleSet {
036:
037: /**
038: * Overrides {@link ToolboxRuleSet} to add create-session rule.
039: *
040: * <p>These rules assume that an instance of
041: * <code>org.apache.velocity.tools.view.ServletToolboxManager</code> is
042: * pushed onto the evaluation stack before parsing begins.</p>
043: *
044: * @param digester Digester instance to which the new Rule instances
045: * should be added.
046: */
047: public void addRuleInstances(Digester digester) {
048: digester.addRule("toolbox/create-session",
049: new CreateSessionRule());
050: digester.addRule("toolbox/xhtml", new XhtmlRule());
051: super .addRuleInstances(digester);
052: }
053:
054: /**
055: * Overrides {@link ToolboxRuleSet} to add rule for scope element.
056: */
057: protected void addToolRules(Digester digester) {
058: super .addToolRules(digester);
059: digester.addBeanPropertySetter("toolbox/tool/scope", "scope");
060: digester.addBeanPropertySetter("toolbox/tool/request-path",
061: "requestPath");
062: }
063:
064: /**
065: * Overrides {@link ToolboxRuleSet} to use ServletToolInfo class.
066: */
067: protected Class getToolInfoClass() {
068: return ServletToolInfo.class;
069: }
070:
071: /****************************** Custom Rules *****************************/
072:
073: /**
074: * Abstract rule for configuring boolean options on the parent
075: * object/element of the matching element.
076: */
077: protected abstract class BooleanConfigRule extends Rule {
078: public void body(String ns, String name, String text)
079: throws Exception {
080: Object parent = digester.peek();
081: if ("yes".equalsIgnoreCase(text)) {
082: setBoolean(parent, Boolean.TRUE);
083: } else {
084: setBoolean(parent, Boolean.valueOf(text));
085: }
086: }
087:
088: /**
089: * Takes the parent object and boolean value in order to
090: * call the appropriate method on the parent for the
091: * implementing rule.
092: *
093: * @param parent the parent object/element in the digester's stack
094: * @param value the boolean value contained in the current element
095: */
096: public abstract void setBoolean(Object parent, Boolean value)
097: throws Exception;
098: }
099:
100: /**
101: * Rule that sets <code>setCreateSession()</code> for the top object
102: * on the stack, which must be a
103: * <code>org.apache.velocity.tools.ServletToolboxManager</code>.
104: */
105: protected final class CreateSessionRule extends BooleanConfigRule {
106: public void setBoolean(Object obj, Boolean b) throws Exception {
107: ((ServletToolboxManager) obj).setCreateSession(b
108: .booleanValue());
109: }
110: }
111:
112: /**
113: * Rule that sets <code>setXhtml()</code> for the top object
114: * on the stack, which must be a
115: * <code>org.apache.velocity.tools.ServletToolboxManager</code>.
116: */
117: protected final class XhtmlRule extends BooleanConfigRule {
118: public void setBoolean(Object obj, Boolean b) throws Exception {
119: ((ServletToolboxManager) obj).setXhtml(b);
120: }
121: }
122:
123: }
|