org.apache.velocity.tools.view
Class XMLToolboxManager

java.lang.Object
  extended by org.apache.velocity.tools.view.XMLToolboxManager
All Implemented Interfaces:
ToolboxManager
Direct Known Subclasses:
ServletToolboxManager

Deprecated. Use XmlFactoryConfiguration

@Deprecated
public class XMLToolboxManager
extends Object
implements ToolboxManager

A ToolboxManager for loading a toolbox from xml.

A toolbox manager is responsible for automatically filling the Velocity context with a set of view tools. This class provides the following features:

Configuration

The toolbox manager is configured through an XML-based configuration file. The configuration file is passed to the load(java.io.InputStream input) method. The format is shown in the following example:

 <?xml version="1.0"?>
 <toolbox>
   <tool>
      <key>date</key>
      <class>org.apache.velocity.tools.generic.DateTool</class>
   </tool>
   <data type="Number">
      <key>luckynumber</key>
      <value>1.37</value>
   </data>
   <data type="String">
      <key>greeting</key>
      <value>Hello World!</value>
   </data>
 </toolbox>
 

Version:
$Id: XMLToolboxManager.java 961796 2010-07-08 15:18:15Z apetrelli $
Author:
Nathan Bubna, Geir Magnusson Jr., Henning P. Schmiedehausen

Field Summary
protected static org.apache.commons.logging.Log LOG
          Deprecated.  
 
Constructor Summary
XMLToolboxManager()
          Deprecated. Default constructor
 
Method Summary
 void addData(ToolInfo info)
          Deprecated. Adds a data object for the context.
 void addTool(ToolInfo info)
          Deprecated. Adds a tool to be managed
protected  org.apache.commons.digester.RuleSet getRuleSet()
          Deprecated. Retrieves the rule set Digester should use to parse and load the toolbox for this manager.
 Map getToolbox(Object initData)
          Deprecated. Retrieves a map of the tools and data being managed.
 void load(InputStream input)
          Deprecated. Reads an XML document from an InputStream and sets up the toolbox from that.
 void load(String path)
          Deprecated. Reads an XML document from the specified file path and sets up the toolbox from that.
protected  boolean validateToolInfo(ToolInfo info)
          Deprecated. Checks whether an object described by a ToolInfo passes some basic sanity checks.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG
Deprecated. 
Constructor Detail

XMLToolboxManager

public XMLToolboxManager()
Deprecated. 
Default constructor

Method Detail

addTool

public void addTool(ToolInfo info)
Deprecated. 
Description copied from interface: ToolboxManager
Adds a tool to be managed

Specified by:
addTool in interface ToolboxManager

addData

public void addData(ToolInfo info)
Deprecated. 
Description copied from interface: ToolboxManager
Adds a data object for the context.

Specified by:
addData in interface ToolboxManager
Parameters:
info - An object that implements ToolInfo

validateToolInfo

protected boolean validateToolInfo(ToolInfo info)
Deprecated. 
Checks whether an object described by a ToolInfo passes some basic sanity checks.

Parameters:
info - A ToolInfo object
Returns:
true if the ToolInfo is valid

getToolbox

public Map getToolbox(Object initData)
Deprecated. 
Description copied from interface: ToolboxManager
Retrieves a map of the tools and data being managed. Tools that have an init(Object) method will be (re)initialized using the specified initData.

Specified by:
getToolbox in interface ToolboxManager
Parameters:
initData - data used to initialize tools
Returns:
the created ToolboxContext

load

public void load(String path)
          throws Exception
Deprecated. 

Reads an XML document from the specified file path and sets up the toolbox from that. If the file does not exist, an IllegalArgumentException will be thrown.

Parameters:
path - the path to the file to be read from
Throws:
Exception
Since:
VelocityTools 1.3

load

public void load(InputStream input)
          throws Exception
Deprecated. 

Reads an XML document from an InputStream and sets up the toolbox from that.

Parameters:
input - the InputStream to read from
Throws:
Exception

getRuleSet

protected org.apache.commons.digester.RuleSet getRuleSet()
Deprecated. 

Retrieves the rule set Digester should use to parse and load the toolbox for this manager.

The DTD corresponding to the default ToolboxRuleSet is:

  <?xml version="1.0"?>
  <!ELEMENT toolbox (tool*,data*,#PCDATA)>
  <!ELEMENT tool    (key,class,parameter*,#PCDATA)>
  <!ELEMENT data    (key,value)>
      <!ATTLIST data type (string|number|boolean) "string">
  <!ELEMENT key     (#CDATA)>
  <!ELEMENT class   (#CDATA)>
  <!ELEMENT parameter (EMPTY)>
      <!ATTLIST parameter name CDATA #REQUIRED>
      <!ATTLIST parameter value CDATA #REQUIRED>
  <!ELEMENT value   (#CDATA)>
 

Since:
VelocityTools 1.1


Copyright © 2002-2011 The Apache Software Foundation. All Rights Reserved.