Package org.apache.velocity.tools.config

Class XmlFactoryConfigurationRuleSet

  • All Implemented Interfaces:
    org.apache.commons.digester.RuleSet
    public class XmlFactoryConfigurationRuleSet
extends org.apache.commons.digester.RuleSetBase

    This provides set of Rules used by Commons-Digester to process configuration info formatted as XML. This is the default RuleSet used by XmlFactoryConfiguration.

    Here is a short example XML: 

    
 <tools> 
     <data type="number" key="version" value="1.1"/>
     <data key="isConvertedProp" value="false" class="java.lang.Boolean" converter="org.apache.commons.beanutils.converters.BooleanConverter"/>
     <data type="boolean" key="isKnownType" value="true"/>
     <data key="isAutoType" value="true"/>
     <data key="foo" value="this is foo."/>
     <data key="bar">this is bar.</data>
     <toolbox scope="request" xhtml="true">
         <tool key="toytool" class="ToyTool" restrictTo="index.vm"/>
     </toolbox>
     <toolbox scope="session">
         <property name="createSession" value="true" type="boolean"/>
         <tool key="map" class="java.util.HashMap"/>
     </toolbox>
     <toolbox scope="application">
         <tool class="org.apache.velocity.tools.generic.DateTool"/>
     </toolbox>
 </tools>

    Version:
    $Id: XmlConfiguration.java 511959 2007-02-26 19:24:39Z nbubna $
    Author:
    Nathan Bubna

    • Field Detail

      • toolboxConfigurationClass

        protected Class toolboxConfigurationClass

      • toolConfigurationClass

        protected Class toolConfigurationClass

      • dataClass

        protected Class dataClass

      • propertyClass

        protected Class propertyClass

    • Constructor Detail

      • XmlFactoryConfigurationRuleSet

        public XmlFactoryConfigurationRuleSet()

    • Method Detail

      • setToolboxConfigurationClass

        public void setToolboxConfigurationClass​(Class clazz)

      • setToolConfigurationClass

        public void setToolConfigurationClass​(Class clazz)

      • setDataClass

        public void setDataClass​(Class clazz)

      • setPropertyClass

        public void setPropertyClass​(Class clazz)

      • addRuleInstances

        public void addRuleInstances​(org.apache.commons.digester.Digester digester)

        Add the set of Rule instances defined in this RuleSet to the specified Digester 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 org.apache.velocity.tools.view.ToolboxManager is pushed onto the evaluation stack before parsing begins.

        Specified by:
        addRuleInstances in interface org.apache.commons.digester.RuleSet
        Specified by:
        addRuleInstances in class org.apache.commons.digester.RuleSetBase
        Parameters:
        digester - Digester instance to which the new Rule instances should be added.