Java Doc for XMLToolboxManager.java in  » Template-Engine » Velocity » org » apache » velocity » tools » view » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 XMLToolboxManager.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>
 

Reads an XML document from the specified file path and sets up the toolbox from that.

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)>
 

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.

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