| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> | |
| <!--NewPage--> | |
| <HTML> | |
| <HEAD> | |
| <!-- Generated by javadoc (build 1.5.0_14) on Mon Apr 26 10:16:15 PDT 2010 --> | |
| <TITLE> | |
| XMLToolboxManager (VelocityTools 2.0 Documentation) | |
| </TITLE> | |
| <META NAME="keywords" CONTENT="org.apache.velocity.tools.view.XMLToolboxManager class"> | |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> | |
| <SCRIPT type="text/javascript"> | |
| function windowTitle() | |
| { | |
| parent.document.title="XMLToolboxManager (VelocityTools 2.0 Documentation)"; | |
| } | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| </NOSCRIPT> | |
| </HEAD> | |
| <BODY BGCOLOR="white" onload="windowTitle();"> | |
| <!-- ========= START OF TOP NAVBAR ======= --> | |
| <A NAME="navbar_top"><!-- --></A> | |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_top_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../org/apache/velocity/tools/view/WebappUberspector.SetAttributeExecutor.html" title="class in org.apache.velocity.tools.view"><B>PREV CLASS</B></A> | |
| NEXT CLASS</FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/view/XMLToolboxManager.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="XMLToolboxManager.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_top"></A> | |
| <!-- ========= END OF TOP NAVBAR ========= --> | |
| <HR> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <H2> | |
| <FONT SIZE="-1"> | |
| org.apache.velocity.tools.view</FONT> | |
| <BR> | |
| Class XMLToolboxManager</H2> | |
| <PRE> | |
| java.lang.Object | |
| <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.velocity.tools.view.XMLToolboxManager</B> | |
| </PRE> | |
| <DL> | |
| <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html" title="interface in org.apache.velocity.tools.view">ToolboxManager</A></DD> | |
| </DL> | |
| <DL> | |
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/velocity/tools/view/servlet/ServletToolboxManager.html" title="class in org.apache.velocity.tools.view.servlet">ServletToolboxManager</A></DD> | |
| </DL> | |
| <HR> | |
| <B>Deprecated.</B> <I>Use <A HREF="../../../../../org/apache/velocity/tools/config/XmlFactoryConfiguration.html" title="class in org.apache.velocity.tools.config"><CODE>XmlFactoryConfiguration</CODE></A></I> | |
| <P> | |
| <DL> | |
| <DT><PRE><FONT SIZE="-1">@Deprecated | |
| </FONT>public class <B>XMLToolboxManager</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html" title="interface in org.apache.velocity.tools.view">ToolboxManager</A></DL> | |
| </PRE> | |
| <P> | |
| A ToolboxManager for loading a toolbox from xml. | |
| <p>A toolbox manager is responsible for automatically filling the Velocity | |
| context with a set of view tools. This class provides the following | |
| features:</p> | |
| <ul> | |
| <li>configurable through an XML-based configuration file</li> | |
| <li>assembles a set of view tools (the toolbox) on request</li> | |
| <li>supports any class with a public constructor without parameters | |
| to be used as a view tool</li> | |
| <li>supports adding primitive data values to the context(String,Number,Boolean)</li> | |
| </ul> | |
| <p><strong>Configuration</strong></p> | |
| <p>The toolbox manager is configured through an XML-based configuration | |
| file. The configuration file is passed to the <A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#load(java.io.InputStream)"><CODE>load(java.io.InputStream input)</CODE></A> | |
| method. The format is shown in the following example:</p> | |
| <pre> | |
| <?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> | |
| </pre> | |
| <P> | |
| <P> | |
| <DL> | |
| <DT><B>Version:</B></DT> | |
| <DD>$Id: XMLToolboxManager.java 651470 2008-04-25 00:47:52Z nbubna $</DD> | |
| <DT><B>Author:</B></DT> | |
| <DD>Nathan Bubna, <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>, <a href="mailto:henning@schmiedehausen.org">Henning P. Schmiedehausen</a></DD> | |
| </DL> | |
| <HR> | |
| <P> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <A NAME="field_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Field Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.util.Map</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#data">data</A></B></CODE> | |
| <BR> | |
| <B>Deprecated.</B> </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected static org.apache.commons.logging.Log</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#LOG">LOG</A></B></CODE> | |
| <BR> | |
| <B>Deprecated.</B> </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private static org.apache.commons.digester.RuleSet</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#ruleSet">ruleSet</A></B></CODE> | |
| <BR> | |
| <B>Deprecated.</B> </TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>private java.util.List</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#toolinfo">toolinfo</A></B></CODE> | |
| <BR> | |
| <B>Deprecated.</B> </TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> | |
| <A NAME="constructor_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Constructor Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#XMLToolboxManager()">XMLToolboxManager</A></B>()</CODE> | |
| <BR> | |
| <B>Deprecated.</B> Default constructor</TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <A NAME="method_summary"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> | |
| <B>Method Summary</B></FONT></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#addData(org.apache.velocity.tools.view.ToolInfo)">addData</A></B>(<A HREF="../../../../../org/apache/velocity/tools/view/ToolInfo.html" title="interface in org.apache.velocity.tools.view">ToolInfo</A> info)</CODE> | |
| <BR> | |
| <B>Deprecated.</B> Adds a data object for the context.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#addTool(org.apache.velocity.tools.view.ToolInfo)">addTool</A></B>(<A HREF="../../../../../org/apache/velocity/tools/view/ToolInfo.html" title="interface in org.apache.velocity.tools.view">ToolInfo</A> info)</CODE> | |
| <BR> | |
| <B>Deprecated.</B> Adds a tool to be managed</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected org.apache.commons.digester.RuleSet</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#getRuleSet()">getRuleSet</A></B>()</CODE> | |
| <BR> | |
| <B>Deprecated.</B> Retrieves the rule set Digester should use to parse and load | |
| the toolbox for this manager.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> java.util.Map</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#getToolbox(java.lang.Object)">getToolbox</A></B>(java.lang.Object initData)</CODE> | |
| <BR> | |
| <B>Deprecated.</B> Retrieves a map of the tools and data being managed.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#load(java.io.InputStream)">load</A></B>(java.io.InputStream input)</CODE> | |
| <BR> | |
| <B>Deprecated.</B> Reads an XML document from an <CODE>InputStream</CODE> | |
| and sets up the toolbox from that.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE> void</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#load(java.lang.String)">load</A></B>(java.lang.String path)</CODE> | |
| <BR> | |
| <B>Deprecated.</B> Reads an XML document from the specified file path | |
| and sets up the toolbox from that.</TD> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> | |
| <CODE>protected boolean</CODE></FONT></TD> | |
| <TD><CODE><B><A HREF="../../../../../org/apache/velocity/tools/view/XMLToolboxManager.html#validateToolInfo(org.apache.velocity.tools.view.ToolInfo)">validateToolInfo</A></B>(<A HREF="../../../../../org/apache/velocity/tools/view/ToolInfo.html" title="interface in org.apache.velocity.tools.view">ToolInfo</A> info)</CODE> | |
| <BR> | |
| <B>Deprecated.</B> Checks whether an object described by a ToolInfo passes | |
| some basic sanity checks.</TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> | |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> | |
| </TR> | |
| <TR BGCOLOR="white" CLASS="TableRowColor"> | |
| <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> | |
| </TR> | |
| </TABLE> | |
| | |
| <P> | |
| <!-- ============ FIELD DETAIL =========== --> | |
| <A NAME="field_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Field Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="LOG"><!-- --></A><H3> | |
| LOG</H3> | |
| <PRE> | |
| protected static final org.apache.commons.logging.Log <B>LOG</B></PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="toolinfo"><!-- --></A><H3> | |
| toolinfo</H3> | |
| <PRE> | |
| private java.util.List <B>toolinfo</B></PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="data"><!-- --></A><H3> | |
| data</H3> | |
| <PRE> | |
| private java.util.Map <B>data</B></PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DL> | |
| </DL> | |
| </DL> | |
| <HR> | |
| <A NAME="ruleSet"><!-- --></A><H3> | |
| ruleSet</H3> | |
| <PRE> | |
| private static org.apache.commons.digester.RuleSet <B>ruleSet</B></PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DL> | |
| </DL> | |
| </DL> | |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> | |
| <A NAME="constructor_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Constructor Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="XMLToolboxManager()"><!-- --></A><H3> | |
| XMLToolboxManager</H3> | |
| <PRE> | |
| public <B>XMLToolboxManager</B>()</PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DD>Default constructor | |
| <P> | |
| </DL> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <A NAME="method_detail"><!-- --></A> | |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> | |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> | |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> | |
| <B>Method Detail</B></FONT></TH> | |
| </TR> | |
| </TABLE> | |
| <A NAME="addTool(org.apache.velocity.tools.view.ToolInfo)"><!-- --></A><H3> | |
| addTool</H3> | |
| <PRE> | |
| public void <B>addTool</B>(<A HREF="../../../../../org/apache/velocity/tools/view/ToolInfo.html" title="interface in org.apache.velocity.tools.view">ToolInfo</A> info)</PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html#addTool(org.apache.velocity.tools.view.ToolInfo)">ToolboxManager</A></CODE></B></DD> | |
| <DD>Adds a tool to be managed | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html#addTool(org.apache.velocity.tools.view.ToolInfo)">addTool</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html" title="interface in org.apache.velocity.tools.view">ToolboxManager</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="addData(org.apache.velocity.tools.view.ToolInfo)"><!-- --></A><H3> | |
| addData</H3> | |
| <PRE> | |
| public void <B>addData</B>(<A HREF="../../../../../org/apache/velocity/tools/view/ToolInfo.html" title="interface in org.apache.velocity.tools.view">ToolInfo</A> info)</PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html#addData(org.apache.velocity.tools.view.ToolInfo)">ToolboxManager</A></CODE></B></DD> | |
| <DD>Adds a data object for the context. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html#addData(org.apache.velocity.tools.view.ToolInfo)">addData</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html" title="interface in org.apache.velocity.tools.view">ToolboxManager</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>info</CODE> - An object that implements ToolInfo</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="validateToolInfo(org.apache.velocity.tools.view.ToolInfo)"><!-- --></A><H3> | |
| validateToolInfo</H3> | |
| <PRE> | |
| protected boolean <B>validateToolInfo</B>(<A HREF="../../../../../org/apache/velocity/tools/view/ToolInfo.html" title="interface in org.apache.velocity.tools.view">ToolInfo</A> info)</PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DD>Checks whether an object described by a ToolInfo passes | |
| some basic sanity checks. | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>info</CODE> - A ToolInfo object | |
| <DT><B>Returns:</B><DD>true if the ToolInfo is valid</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getToolbox(java.lang.Object)"><!-- --></A><H3> | |
| getToolbox</H3> | |
| <PRE> | |
| public java.util.Map <B>getToolbox</B>(java.lang.Object initData)</PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html#getToolbox(java.lang.Object)">ToolboxManager</A></CODE></B></DD> | |
| <DD>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. | |
| <P> | |
| <DD><DL> | |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html#getToolbox(java.lang.Object)">getToolbox</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/velocity/tools/view/ToolboxManager.html" title="interface in org.apache.velocity.tools.view">ToolboxManager</A></CODE></DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>initData</CODE> - data used to initialize tools | |
| <DT><B>Returns:</B><DD>the created ToolboxContext</DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="load(java.lang.String)"><!-- --></A><H3> | |
| load</H3> | |
| <PRE> | |
| public void <B>load</B>(java.lang.String path) | |
| throws java.lang.Exception</PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DD><p>Reads an XML document from the specified file path | |
| and sets up the toolbox from that. If the file does not | |
| exist, an <CODE>IllegalArgumentException</CODE> will be thrown.</p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>path</CODE> - the path to the file to be read from | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.Exception</CODE><DT><B>Since:</B></DT> | |
| <DD>VelocityTools 1.3</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="load(java.io.InputStream)"><!-- --></A><H3> | |
| load</H3> | |
| <PRE> | |
| public void <B>load</B>(java.io.InputStream input) | |
| throws java.lang.Exception</PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DD><p>Reads an XML document from an <CODE>InputStream</CODE> | |
| and sets up the toolbox from that.</p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Parameters:</B><DD><CODE>input</CODE> - the InputStream to read from | |
| <DT><B>Throws:</B> | |
| <DD><CODE>java.lang.Exception</CODE></DL> | |
| </DD> | |
| </DL> | |
| <HR> | |
| <A NAME="getRuleSet()"><!-- --></A><H3> | |
| getRuleSet</H3> | |
| <PRE> | |
| protected org.apache.commons.digester.RuleSet <B>getRuleSet</B>()</PRE> | |
| <DL> | |
| <DD><B>Deprecated.</B> <DD><p>Retrieves the rule set Digester should use to parse and load | |
| the toolbox for this manager.</p> | |
| <p>The DTD corresponding to the default ToolboxRuleSet is: | |
| <pre> | |
| <?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)> | |
| </pre></p> | |
| <P> | |
| <DD><DL> | |
| </DL> | |
| </DD> | |
| <DD><DL> | |
| <DT><B>Since:</B></DT> | |
| <DD>VelocityTools 1.1</DD> | |
| </DL> | |
| </DD> | |
| </DL> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <HR> | |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> | |
| <A NAME="navbar_bottom"><!-- --></A> | |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> | |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> | |
| <TR> | |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> | |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> | |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> | |
| <TR ALIGN="center" VALIGN="top"> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> | |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> | |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> | |
| </TR> | |
| </TABLE> | |
| </TD> | |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> | |
| </EM> | |
| </TD> | |
| </TR> | |
| <TR> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../org/apache/velocity/tools/view/WebappUberspector.SetAttributeExecutor.html" title="class in org.apache.velocity.tools.view"><B>PREV CLASS</B></A> | |
| NEXT CLASS</FONT></TD> | |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> | |
| <A HREF="../../../../../index.html?org/apache/velocity/tools/view/XMLToolboxManager.html" target="_top"><B>FRAMES</B></A> | |
| <A HREF="XMLToolboxManager.html" target="_top"><B>NO FRAMES</B></A> | |
| <SCRIPT type="text/javascript"> | |
| <!-- | |
| if(window==top) { | |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); | |
| } | |
| //--> | |
| </SCRIPT> | |
| <NOSCRIPT> | |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> | |
| </NOSCRIPT> | |
| </FONT></TD> | |
| </TR> | |
| <TR> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> | |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> | |
| DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> | |
| </TR> | |
| </TABLE> | |
| <A NAME="skip-navbar_bottom"></A> | |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> | |
| <HR> | |
| Copyright (c) 2003-2007 Apache Software Foundation | |
| </BODY> | |
| </HTML> |