org.apache.velocity.tools.view
Class XMLToolboxManager

java.lang.Object
  org.apache.velocity.tools.view.XMLToolboxManager

All Implemented Interfaces:

ToolboxManager

Direct Known Subclasses:

ServletToolboxManager

Deprecated. Use XmlFactoryConfiguration

@Deprecated
public class XMLToolboxManager
extends java.lang.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:

• configurable through an XML-based configuration file
• assembles a set of view tools (the toolbox) on request
• supports any class with a public constructor without parameters to be used as a view tool
• supports adding primitive data values to the context(String,Number,Boolean)

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 651470 2008-04-25 00:47:52Z nbubna $

Author:

Nathan Bubna, Geir Magnusson Jr., Henning P. Schmiedehausen

Field Summary

private java.util.Map	data Deprecated.
protected static org.apache.commons.logging.Log	LOG Deprecated.
private static org.apache.commons.digester.RuleSet	ruleSet Deprecated.
private java.util.List	toolinfo 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.
java.util.Map	getToolbox(java.lang.Object initData) Deprecated. Retrieves a map of the tools and data being managed.
void	load(java.io.InputStream input) Deprecated. Reads an XML document from an InputStream and sets up the toolbox from that.
void	load(java.lang.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.

toolinfo

private java.util.List toolinfo

Deprecated.

data

private java.util.Map data

Deprecated.

ruleSet

private static org.apache.commons.digester.RuleSet ruleSet

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 java.util.Map getToolbox(java.lang.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(java.lang.String path)
          throws java.lang.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:

java.lang.Exception

Since:

VelocityTools 1.3

load

public void load(java.io.InputStream input)
          throws java.lang.Exception

Deprecated.

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

Parameters:

input - the InputStream to read from

Throws:

java.lang.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