You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by nb...@apache.org on 2003/07/22 20:32:29 UTC
cvs commit: jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/servlet ServletToolboxRuleSet.java
nbubna 2003/07/22 11:32:29
Added: src/java/org/apache/velocity/tools/view ToolboxRuleSet.java
src/java/org/apache/velocity/tools/view/servlet
ServletToolboxRuleSet.java
Log:
Initial revision of rule sets for toolbox digesting
Revision Changes Path
1.1 jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/ToolboxRuleSet.java
Index: ToolboxRuleSet.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. 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 acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* 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 APACHE SOFTWARE FOUNDATION 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 Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view;
import org.apache.commons.digester.Digester;
import org.apache.commons.digester.RuleSetBase;
import org.apache.velocity.tools.view.DataInfo;
import org.apache.velocity.tools.view.ViewToolInfo;
/**
* <p>The set of Digester rules required to parse a toolbox
* configuration file (<code>toolbox.xml</code>) for the
* XMLToolboxManager class.</p>
*
* @author <a href="mailto:nathan@esha.com">Nathan Bubna</a>
* @version $Id: ToolboxRuleSet.java,v 1.1 2003/07/22 18:32:29 nbubna Exp $
*/
public class ToolboxRuleSet extends RuleSetBase
{
/**
* <p>Add the set of Rule instances defined in this RuleSet to the
* specified <code>Digester</code> instance, associating them with
* our namespace URI (if any). This method should only be called
* by a Digester instance. These rules assume that an instance of
* <code>org.apache.velocity.tools.view.ToolboxManager</code> is pushed
* onto the evaluation stack before parsing begins.</p>
*
* @param digester Digester instance to which the new Rule instances
* should be added.
*/
public void addRuleInstances(Digester digester)
{
addToolRules(digester);
addDataRules(digester);
}
/**
* Add rules for digesting tool elements.
*/
protected void addToolRules(Digester digester)
{
digester.addObjectCreate("toolbox/tool", getToolInfoClass());
digester.addBeanPropertySetter("toolbox/tool/key", "key");
digester.addBeanPropertySetter("toolbox/tool/class", "classname");
digester.addSetNext("toolbox/tool", "addTool");
}
/**
* Add rules for digesting data elements.
*/
protected void addDataRules(Digester digester)
{
digester.addObjectCreate("toolbox/data", getDataInfoClass());
digester.addSetProperties("toolbox/data");
digester.addBeanPropertySetter("toolbox/data/key", "key");
digester.addBeanPropertySetter("toolbox/data/value", "value");
digester.addSetNext("toolbox/data", "addTool");
}
/**
* Return the bean class to be created for tool elements.
*/
protected Class getToolInfoClass()
{
return ViewToolInfo.class;
}
/**
* Return the bean class to be created for data elements.
*/
protected Class getDataInfoClass()
{
return DataInfo.class;
}
}
1.1 jakarta-velocity-tools/src/java/org/apache/velocity/tools/view/servlet/ServletToolboxRuleSet.java
Index: ServletToolboxRuleSet.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2003 The Apache Software Foundation. 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 acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* 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 APACHE SOFTWARE FOUNDATION 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 Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view.servlet;
import org.apache.commons.digester.Digester;
import org.apache.commons.digester.Rule;
import org.apache.velocity.tools.view.ToolboxRuleSet;
import org.apache.velocity.tools.view.servlet.ServletToolboxManager;
import org.apache.velocity.tools.view.servlet.ServletToolInfo;
/**
* <p>The set of Digester rules required to parse a toolbox
* configuration file (<code>toolbox.xml</code>) for the
* ServletToolboxManager class.</p>
*
* @author <a href="mailto:nathan@esha.com">Nathan Bubna</a>
* @version $Id: ServletToolboxRuleSet.java,v 1.1 2003/07/22 18:32:29 nbubna Exp $
*/
public class ServletToolboxRuleSet extends ToolboxRuleSet
{
/**
* Overrides {@link ToolboxRuleSet} to add create-session rule.
*
* <p>These rules assume that an instance of
* <code>org.apache.velocity.tools.view.ServletToolboxManager</code> is
* pushed onto the evaluation stack before parsing begins.</p>
*
* @param digester Digester instance to which the new Rule instances
* should be added.
*/
public void addRuleInstances(Digester digester)
{
digester.addRule("toolbox/create-session", new CreateSessionRule());
super.addRuleInstances(digester);
}
/**
* Overrides {@link ToolboxRuleSet} to add rule for scope element.
*/
protected void addToolRules(Digester digester)
{
super.addToolRules(digester);
digester.addBeanPropertySetter("toolbox/tool/scope", "scope");
}
/**
* Overrides {@link ToolboxRuleSet} to use ServletToolInfo class.
*/
protected Class getToolInfoClass()
{
return ServletToolInfo.class;
}
/**
* Rule that sets <code>setCreateSession()</code> for the top object
* on the stack, which must be a
* <code>org.apache.velocity.tools.ServletToolboxManager</code>.
*/
protected final class CreateSessionRule extends Rule {
public CreateSessionRule() {
super();
}
public void body(String ns, String name, String text) throws Exception
{
ServletToolboxManager stm = (ServletToolboxManager)digester.peek();
if ("yes".equalsIgnoreCase(text))
{
stm.setCreateSession(true);
}
else
{
/* follow java rules for boolean value parsing
* (equivalent to "true".equalsIgnoreCase(text) )*/
stm.setCreateSession(Boolean.valueOf(text).booleanValue());
}
}
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org