You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by si...@apache.org on 2002/04/15 20:30:30 UTC
cvs commit: jakarta-velocity-tools/xdocs index.xml site.dvsl vellibrary.xml
sidler 02/04/15 11:30:30
Modified: . README.txt build.xml
struts README.txt
struts/examples/struts index.html
struts/examples/struts/WEB-INF/lib
velocity-tools-library-0.1.jar
velocity-tools-view-0.6.jar
struts/examples/struts/WEB-INF/src/examples/app2
DemoAction.java
struts/examples/struts/doc examples.html
struts/examples/struts/examples/context_tools
mathtool-demo.txt mathtool-demo.vm
struts/examples/struts/examples/struts_app2 tool-demo.txt
tool-demo.vm
struts/lib velocity-tools-view-0.6.jar
struts/src/java/org/apache/velocity/tools/struts
ErrorsTool.java FormTool.java LinkTool.java
MessageTool.java StrutsUtils.java package.html
struts/xdocs index.xml menue.xml tools.xml userguide.xml
tools README.txt
tools/lib velocity-tools-view-0.6.jar
tools/src/java/org/apache/velocity/tools/tools DateTool.java
MathTool.java ParameterParser.java ToolLoader.java
package.html
tools/xdocs ParameterParser.xml ToolLoader.xml
view README.txt
view/src/java/org/apache/velocity/tools/view/context
ChainedContext.java ToolboxContext.java
ViewContext.java
view/src/java/org/apache/velocity/tools/view/i18n
MultiViewsTool.java
view/src/java/org/apache/velocity/tools/view/servlet
ServletToolboxManager.java
view/src/java/org/apache/velocity/tools/view/tools
package.html
view/xdocs velservlet.xml
xdocs index.xml site.dvsl vellibrary.xml
Added: view/src/java/org/apache/velocity/tools/view/servlet
ServletViewToolLogger.java
view/src/java/org/apache/velocity/tools/view/tools
ContextViewTool.java LogEnabledViewTool.java
LogEnabledViewToolImpl.java ServletViewTool.java
ThreadSafeViewTool.java ViewToolLogger.java
Removed: view/src/java/org/apache/velocity/tools/view/servlet
ServletContextToolLogger.java
view/src/java/org/apache/velocity/tools/view/tools
ContextContextTool.java ContextToolLogger.java
LogEnabledContextTool.java
LogEnabledContextToolImpl.java
ServletContextTool.java ThreadSafeContextTool.java
Log:
Replaced the term "context tool" by "view tool" in the documentation and
source.
Revision Changes Path
1.5 +1 -1 jakarta-velocity-tools/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/README.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- README.txt 2 Apr 2002 16:46:29 -0000 1.4
+++ README.txt 15 Apr 2002 18:30:27 -0000 1.5
@@ -13,7 +13,7 @@
struts/README.txt for more information. There are several
nice application examples included.
-tools : A collection of general purpose context tools. See
+tools : A collection of general purpose view tools. See
tools/REAMDE.txt for more information.
1.3 +2 -2 jakarta-velocity-tools/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/build.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- build.xml 4 Apr 2002 09:18:55 -0000 1.2
+++ build.xml 15 Apr 2002 18:30:27 -0000 1.3
@@ -169,8 +169,8 @@
<package name="org.apache.velocity.tools.view.tools"/>
<package name="org.apache.velocity.tools.view.context"/>
- <group title="Context Tools" packages="org.apache.velocity.tools.tools:org.apache.velocity.tools.struts"/>
- <group title="Context Tools Infrastructure" packages="org.apache.velocity.tools.view.tools:org.apache.velocity.tools.view.context"/>
+ <group title="View Tools" packages="org.apache.velocity.tools.tools:org.apache.velocity.tools.struts"/>
+ <group title="View Tools Infrastructure" packages="org.apache.velocity.tools.view.tools:org.apache.velocity.tools.view.context"/>
<classpath refid="classpath"/>
1.5 +2 -2 jakarta-velocity-tools/struts/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/README.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- README.txt 2 Apr 2002 16:46:29 -0000 1.4
+++ README.txt 15 Apr 2002 18:30:27 -0000 1.5
@@ -4,7 +4,7 @@
This part of jakarta-velocity-tools is focused on Struts-Velocity
integration using the VelocityViewServlet and other tools found
in this project. Struts support in Velocity is provided through
-several context tools.
+several view tools.
This is an alpha version. We do not recommend that you build production
systems based on this software at this stage. The API may still
@@ -24,7 +24,7 @@
and sets up the examples.
The directory 'docs' contains reference documentation for the included
-context tools. More documentation will be added shortly. For now the
+view tools. More documentation will be added shortly. For now the
best way to get a feel for the Struts Velocity integration is to look
at the included examples.
1.7 +1 -1 jakarta-velocity-tools/struts/examples/struts/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/index.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- index.html 2 Apr 2002 16:46:29 -0000 1.6
+++ index.html 15 Apr 2002 18:30:27 -0000 1.7
@@ -46,7 +46,7 @@
<h5>Application Examples</h5>
<p>Five small <a href="doc/examples.html">application examples</a> have
been included. Look at example 2 for a demonstration of the Velocity
-context tools for Struts. JSP versions of some of the examples have
+view tools for Struts. JSP versions of some of the examples have
been included to allow a direct comparison of the two view technologies.
</p>
1.2 +36 -39 jakarta-velocity-tools/struts/examples/struts/WEB-INF/lib/velocity-tools-library-0.1.jar
<<Binary file>>
1.2 +62 -81 jakarta-velocity-tools/struts/examples/struts/WEB-INF/lib/velocity-tools-view-0.6.jar
<<Binary file>>
1.2 +2 -2 jakarta-velocity-tools/struts/examples/struts/WEB-INF/src/examples/app2/DemoAction.java
Index: DemoAction.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/WEB-INF/src/examples/app2/DemoAction.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DemoAction.java 12 Mar 2002 11:36:48 -0000 1.1
+++ DemoAction.java 15 Apr 2002 18:30:27 -0000 1.2
@@ -27,10 +27,10 @@
/**
- * <p>A simple action used to demonstrate the context tools.</p>
+ * <p>A simple action used to demonstrate the view tools.</p>
*
* @author <a href="mailto:sidler@teamup.com"/>Gabe Sidler</a>
- * @version $Id: DemoAction.java,v 1.1 2002/03/12 11:36:48 sidler Exp $
+ * @version $Id: DemoAction.java,v 1.2 2002/04/15 18:30:27 sidler Exp $
*/
public class DemoAction extends Action
{
1.3 +7 -7 jakarta-velocity-tools/struts/examples/struts/doc/examples.html
Index: examples.html
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/doc/examples.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- examples.html 2 Apr 2002 16:46:30 -0000 1.2
+++ examples.html 15 Apr 2002 18:30:27 -0000 1.3
@@ -35,13 +35,13 @@
</ul>
<p> </p>
</li>
- <li><b>Struts App2: Struts Context Tool Demo</b><br>
- This application demonstrates the Velocity context tools for Struts. These context
+ <li><b>Struts App2: Struts View Tools Demo</b><br>
+ This application demonstrates the Velocity view tools for Struts. These view
tool enable view designers to access the resources of the Struts framework. Their
functionality is a subset of the functionality provided by the Struts custom tag
libraries for JSP.
<ul>
- <li><a href="../demo.do" target="demo">Struts Context Tool Demo</a>
+ <li><a href="../demo.do" target="demo">Struts View Tools Demo</a>
(<a href="../examples/struts_app2/tool-demo.txt">template</a>)</li>
</ul>
<p> </p>
@@ -56,10 +56,10 @@
<p> </p>
</li>
<li>
- <p><b>Context Tool Demo: MathTool</b><br>
- This example demonstrates how a context tool can be loaded from within a
- template by the view designer. The tool used to load context tools is
- a context tool itself. It is defined in toolbox.xml and pre-loaded during initialization.
+ <p><b>View Tool Demo: MathTool</b><br>
+ This example demonstrates how a view tool can be loaded from within a
+ template by the view designer. The tool used to load view tools is
+ a view tool itself. It is defined in toolbox.xml and pre-loaded during initialization.
<ul>
<li><a href="../examples/context_tools/mathtool-demo.vm" target="demo">Math Tool Demo</a>
(<a href="../examples/context_tools/mathtool-demo.txt">template</a>)</li>
1.5 +1 -1 jakarta-velocity-tools/struts/examples/struts/examples/context_tools/mathtool-demo.txt
Index: mathtool-demo.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/examples/context_tools/mathtool-demo.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- mathtool-demo.txt 2 Apr 2002 16:46:30 -0000 1.4
+++ mathtool-demo.txt 15 Apr 2002 18:30:27 -0000 1.5
@@ -7,7 +7,7 @@
<h2>MathTool Demo (Velocity)</h2>
- First, load the MathTool context tool into the context with key "math":<br>
+ First, load the MathTool view tool into the context with key "math":<br>
<code>$toolLoader.load("math", "org.apache.velocity.tools.tools.MathTool")</code><br><br>
$toolLoader.load("math", "org.apache.velocity.tools.tools.MathTool")
1.5 +1 -1 jakarta-velocity-tools/struts/examples/struts/examples/context_tools/mathtool-demo.vm
Index: mathtool-demo.vm
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/examples/context_tools/mathtool-demo.vm,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- mathtool-demo.vm 2 Apr 2002 16:46:30 -0000 1.4
+++ mathtool-demo.vm 15 Apr 2002 18:30:27 -0000 1.5
@@ -7,7 +7,7 @@
<h2>MathTool Demo (Velocity)</h2>
- First, load the MathTool context tool into the context with key "math":<br>
+ First, load the MathTool view tool into the context with key "math":<br>
<code>$toolLoader.load("math", "org.apache.velocity.tools.tools.MathTool")</code><br><br>
$toolLoader.load("math", "org.apache.velocity.tools.tools.MathTool")
1.5 +3 -3 jakarta-velocity-tools/struts/examples/struts/examples/struts_app2/tool-demo.txt
Index: tool-demo.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/examples/struts_app2/tool-demo.txt,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- tool-demo.txt 2 Apr 2002 16:46:30 -0000 1.4
+++ tool-demo.txt 15 Apr 2002 18:30:28 -0000 1.5
@@ -1,13 +1,13 @@
<html>
<head>
- <title>Struts App2: Struts Context Tool Demo</title>
+ <title>Struts App2: Struts View Tools Demo</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<base href="$link.baseRef">
</head>
<body>
- <h2>Struts App2: Struts Context Tool Demo</h2>
- <p>A demonstration of the Velocity context tools provided for Struts support.
+ <h2>Struts App2: Struts View Tools Demo</h2>
+ <p>A demonstration of the Velocity view tools provided for Struts support.
Where available, the Velocity shorthand notation to method calls is shown
as well.</p>
1.5 +3 -3 jakarta-velocity-tools/struts/examples/struts/examples/struts_app2/tool-demo.vm
Index: tool-demo.vm
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/examples/struts_app2/tool-demo.vm,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- tool-demo.vm 2 Apr 2002 16:46:30 -0000 1.4
+++ tool-demo.vm 15 Apr 2002 18:30:28 -0000 1.5
@@ -1,13 +1,13 @@
<html>
<head>
- <title>Struts App2: Struts Context Tool Demo</title>
+ <title>Struts App2: Struts View Tools Demo</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<base href="$link.baseRef">
</head>
<body>
- <h2>Struts App2: Struts Context Tool Demo</h2>
- <p>A demonstration of the Velocity context tools provided for Struts support.
+ <h2>Struts App2: Struts View Tools Demo</h2>
+ <p>A demonstration of the Velocity view tools provided for Struts support.
Where available, the Velocity shorthand notation to method calls is shown
as well.</p>
1.2 +62 -81 jakarta-velocity-tools/struts/lib/velocity-tools-view-0.6.jar
<<Binary file>>
1.4 +12 -12 jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/ErrorsTool.java
Index: ErrorsTool.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/ErrorsTool.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ErrorsTool.java 2 Apr 2002 16:46:30 -0000 1.3
+++ ErrorsTool.java 15 Apr 2002 18:30:28 -0000 1.4
@@ -66,17 +66,17 @@
import org.apache.struts.action.*;
import org.apache.velocity.tools.view.context.ViewContext;
-import org.apache.velocity.tools.view.tools.LogEnabledContextToolImpl;
-import org.apache.velocity.tools.view.tools.ServletContextTool;
+import org.apache.velocity.tools.view.tools.LogEnabledViewToolImpl;
+import org.apache.velocity.tools.view.tools.ServletViewTool;
/**
- * <p>Context tool to work with the Struts error messages.</p>
+ * <p>View tool to work with the Struts error messages.</p>
*
* <p>This class is equipped to be used with a toolbox manager, for example
* the ServletToolboxManager included with VelServlet. The class extends
- * ServletContextToolLogger to profit from the logging facilities of that class.
- * Furthermore, this class implements interface ServletContextTool, which allows
+ * ServletViewToolLogger to profit from the logging facilities of that class.
+ * Furthermore, this class implements interface ServletViewTool, which allows
* a toolbox manager to pass the required context information.</p>
*
* <p>This class is not thread-safe by design. A new instance is needed for
@@ -85,11 +85,11 @@
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
- * @version $Id: ErrorsTool.java,v 1.3 2002/04/02 16:46:30 sidler Exp $
+ * @version $Id: ErrorsTool.java,v 1.4 2002/04/15 18:30:28 sidler Exp $
*
*/
-public class ErrorsTool extends LogEnabledContextToolImpl
- implements ServletContextTool
+public class ErrorsTool extends LogEnabledViewToolImpl
+ implements ServletViewTool
{
// --------------------------------------------- Properties ---------------
@@ -160,10 +160,10 @@
- // ----------------------------------- Interface ServletContextTool -------
+ // ----------------------------------- Interface ServletViewTool ----------
/**
- * Returns an initialized instance of this context tool.
+ * Returns an initialized instance of this view tool.
*/
public Object getInstance(ViewContext context)
{
@@ -173,13 +173,13 @@
/**
* <p>Returns the default life cycle for this tool. This is
- * {@link ServletContextTool#REQUEST}. Do not overwrite this
+ * {@link ServletViewTool#REQUEST}. Do not overwrite this
* per toolbox configuration. No alternative life cycles are
* supported by this tool</p>
*/
public String getDefaultLifecycle()
{
- return ServletContextTool.REQUEST;
+ return ServletViewTool.REQUEST;
}
1.4 +12 -12 jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/FormTool.java
Index: FormTool.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/FormTool.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- FormTool.java 2 Apr 2002 16:46:30 -0000 1.3
+++ FormTool.java 15 Apr 2002 18:30:28 -0000 1.4
@@ -62,17 +62,17 @@
import org.apache.struts.action.*;
import org.apache.velocity.tools.view.context.ViewContext;
-import org.apache.velocity.tools.view.tools.LogEnabledContextToolImpl;
-import org.apache.velocity.tools.view.tools.ServletContextTool;
+import org.apache.velocity.tools.view.tools.LogEnabledViewToolImpl;
+import org.apache.velocity.tools.view.tools.ServletViewTool;
/**
- * <p>Context tool to work with HTML forms in Struts.</p>
+ * <p>View tool to work with HTML forms in Struts.</p>
*
* <p>This class is equipped to be used with a toolbox manager, for example
* the ServletToolboxManager included with VelServlet. The class extends
- * ServletContextToolLogger to profit from the logging facilities of that class.
- * Furthermore, this class implements interface ServletContextTool, which allows
+ * ServletViewToolLogger to profit from the logging facilities of that class.
+ * Furthermore, this class implements interface ServletViewTool, which allows
* a toolbox manager to pass the required context information.</p>
*
* <p>This class is not thread-safe by design. A new instance is needed for
@@ -80,11 +80,11 @@
*
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
- * @version $Id: FormTool.java,v 1.3 2002/04/02 16:46:30 sidler Exp $
+ * @version $Id: FormTool.java,v 1.4 2002/04/15 18:30:28 sidler Exp $
*
*/
-public class FormTool extends LogEnabledContextToolImpl
- implements ServletContextTool
+public class FormTool extends LogEnabledViewToolImpl
+ implements ServletViewTool
{
// --------------------------------------------- Properties ---------------
@@ -128,10 +128,10 @@
- // ----------------------------------- Interface ServletContextTool -------
+ // ----------------------------------- Interface ServletViewTool -------
/**
- * Returns an initialized instance of this context tool.
+ * Returns an initialized instance of this view tool.
*/
public Object getInstance(ViewContext context)
{
@@ -141,13 +141,13 @@
/**
* <p>Returns the default life cycle for this tool. This is
- * {@link ServletContextTool#REQUEST}. Do not overwrite this
+ * {@link ServletViewTool#REQUEST}. Do not overwrite this
* per toolbox configuration. No alternative life cycles are
* supported by this tool</p>
*/
public String getDefaultLifecycle()
{
- return ServletContextTool.REQUEST;
+ return ServletViewTool.REQUEST;
}
1.5 +12 -12 jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/LinkTool.java
Index: LinkTool.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/LinkTool.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- LinkTool.java 15 Apr 2002 10:45:32 -0000 1.4
+++ LinkTool.java 15 Apr 2002 18:30:28 -0000 1.5
@@ -67,17 +67,17 @@
import org.apache.struts.action.*;
import org.apache.velocity.tools.view.context.ViewContext;
-import org.apache.velocity.tools.view.tools.LogEnabledContextToolImpl;
-import org.apache.velocity.tools.view.tools.ServletContextTool;
+import org.apache.velocity.tools.view.tools.LogEnabledViewToolImpl;
+import org.apache.velocity.tools.view.tools.ServletViewTool;
/**
- * <p>Context tool to work with URI links in Struts.</p>
+ * <p>View tool to work with URI links in Struts.</p>
*
* <p>This class is equipped to be used with a toolbox manager, for example
* the ServletToolboxManager included with VelServlet. The class extends
- * ServletContextToolLogger to profit from the logging facilities of that class.
- * Furthermore, this class implements interface ServletContextTool, which allows
+ * ServletViewToolLogger to profit from the logging facilities of that class.
+ * Furthermore, this class implements interface ServletViewTool, which allows
* a toolbox manager to pass the required context information.</p>
*
* <p>This class is not thread-safe by design. A new instance is needed for
@@ -86,11 +86,11 @@
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
* @author <a href="mailto:nathan@esha.com">Nathan Bubna</a>
*
- * @version $Id: LinkTool.java,v 1.4 2002/04/15 10:45:32 sidler Exp $
+ * @version $Id: LinkTool.java,v 1.5 2002/04/15 18:30:28 sidler Exp $
*
*/
-public class LinkTool extends LogEnabledContextToolImpl
- implements ServletContextTool
+public class LinkTool extends LogEnabledViewToolImpl
+ implements ServletViewTool
{
// --------------------------------------------- Properties ---------------
@@ -215,10 +215,10 @@
- // ----------------------------------- Interface ServletContextTool -------
+ // ----------------------------------- Interface ServletViewTool -------
/**
- * Returns an initialized instance of this context tool.
+ * Returns an initialized instance of this view tool.
*/
public Object getInstance(ViewContext context)
{
@@ -228,13 +228,13 @@
/**
* <p>Returns the default life cycle for this tool. This is
- * {@link ServletContextTool#REQUEST}. Do not overwrite this
+ * {@link ServletViewTool#REQUEST}. Do not overwrite this
* per toolbox configuration. No alternative life cycles are
* supported by this tool</p>
*/
public String getDefaultLifecycle()
{
- return ServletContextTool.REQUEST;
+ return ServletViewTool.REQUEST;
}
1.4 +13 -13 jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/MessageTool.java
Index: MessageTool.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/MessageTool.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- MessageTool.java 3 Apr 2002 15:30:51 -0000 1.3
+++ MessageTool.java 15 Apr 2002 18:30:28 -0000 1.4
@@ -65,17 +65,17 @@
import org.apache.struts.action.*;
import org.apache.velocity.tools.view.context.ViewContext;
-import org.apache.velocity.tools.view.tools.LogEnabledContextToolImpl;
-import org.apache.velocity.tools.view.tools.ServletContextTool;
+import org.apache.velocity.tools.view.tools.LogEnabledViewToolImpl;
+import org.apache.velocity.tools.view.tools.ServletViewTool;
-/**
- * <p>Context tool that provides methods to render Struts message resources.</p>
+/**
+ * View tool that provides methods to render Struts message resources.</p>
*
* <p>This class is equipped to be used with a toolbox manager, for example
* the ServletToolboxManager included with VelServlet. The class extends
- * ServletContextToolLogger to profit from the logging facilities of that class.
- * Furthermore, this class implements interface ServletContextTool, which allows
+ * ServletViewToolLogger to profit from the logging facilities of that class.
+ * Furthermore, this class implements interface ServletViewTool, which allows
* a toolbox manager to pass the required context information.</p>
*
* <p>This class is not thread-safe by design. A new instance is needed for
@@ -83,11 +83,11 @@
*
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
- * @version $Id: MessageTool.java,v 1.3 2002/04/03 15:30:51 dlr Exp $
+ * @version $Id: MessageTool.java,v 1.4 2002/04/15 18:30:28 sidler Exp $
*
*/
-public class MessageTool extends LogEnabledContextToolImpl
- implements ServletContextTool
+public class MessageTool extends LogEnabledViewToolImpl
+ implements ServletViewTool
{
// --------------------------------------------- Properties -------
@@ -154,10 +154,10 @@
- // ----------------------------------- Interface ServletContextTool -------
+ // ----------------------------------- Interface ServletViewTool -------
/**
- * Returns an initialized instance of this context tool.
+ * Returns an initialized instance of this view tool.
*/
public Object getInstance(ViewContext context)
{
@@ -167,13 +167,13 @@
/**
* <p>Returns the default life cycle for this tool. This is
- * {@link ServletContextTool#REQUEST}. Do not overwrite this
+ * {@link ServletViewTool#REQUEST}. Do not overwrite this
* per toolbox configuration. No alternative life cycles are
* supported by this tool</p>
*/
public String getDefaultLifecycle()
{
- return ServletContextTool.REQUEST;
+ return ServletViewTool.REQUEST;
}
1.3 +2 -2 jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/StrutsUtils.java
Index: StrutsUtils.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/StrutsUtils.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- StrutsUtils.java 2 Apr 2002 16:46:30 -0000 1.2
+++ StrutsUtils.java 15 Apr 2002 18:30:28 -0000 1.3
@@ -79,7 +79,7 @@
* <p>A package-internal utility class to expose the Struts shared
* resources. All methods are static.</p>
*
- * <p>This class is provided for use by Velocity context tools
+ * <p>This class is provided for use by Velocity view tools
* that need access to Struts resources. By having all Struts-
* specific code in this utility class, maintenance is simplified
* and reuse fostered.</p>
@@ -90,7 +90,7 @@
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>, based
* on code by <a href="mailto:ted@husted.org">Ted Husted</a>
*
- * @version $Revision: 1.2 $
+ * @version $Revision: 1.3 $
*/
class StrutsUtils
{
1.2 +1 -1 jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/src/java/org/apache/velocity/tools/struts/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 2 Apr 2002 16:46:30 -0000 1.1
+++ package.html 15 Apr 2002 18:30:28 -0000 1.2
@@ -10,7 +10,7 @@
<body bgcolor="white">
-Provides four context tools that integrate Velocity with the Jakarta
+Provides four view tools that integrate Velocity with the Jakarta
Struts framework.
<!--
1.4 +1 -1 jakarta-velocity-tools/struts/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.xml 4 Apr 2002 09:18:55 -0000 1.3
+++ index.xml 15 Apr 2002 18:30:28 -0000 1.4
@@ -22,7 +22,7 @@
<ul>
<li>Velocity enforces a clear separation of the view aspects of an application from the model and control aspects. This leads to clean application designs and a clear separation of the work of view designers and server developers.</li>
<li>The <a href="http://jakarta.apache.org/velocity/vtl-reference-guide.html">Velocity Template Language</a> (VTL) is a simple and easy to learn scripting language. With less than ten language directives, most people are up and running within a day.</li>
- <li>Velocity is easy to extend with so called <i>Context Tools</i>. Context tools are easier to develop than customer tag libraries in JSP. Any class with public methods can serve as a context tool.</li>
+ <li>Velocity is easy to extend with so called <i>View Tools</i>. View tools are easier to develop than customer tag libraries in JSP. Any class with public methods can serve as a view tool.</li>
<li>Velocity really shines when it comes to access to application data from within the templates. It handles access to objects and their methods very much like in scripting languages such as JavaScript and will feel familiar to template designers.</li>
<li>Velocity is an interpreted language. This leads to a simple development cycle. Template error can easily be localized and debugged.</li>
<li>Many users of Velocity have reported that the performance of Velocity is comparable if not sligthly better than JSP.</li>
1.3 +1 -1 jakarta-velocity-tools/struts/xdocs/menue.xml
Index: menue.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/menue.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- menue.xml 4 Apr 2002 09:18:55 -0000 1.2
+++ menue.xml 15 Apr 2002 18:30:28 -0000 1.3
@@ -21,7 +21,7 @@
<item name="Documentation" href="struts/docs/userguide.html#Documentation"/>
<item name="Model 2 Applications" href="struts/docs/userguide.html#Model 2 Applications"/>
<item name="Velocity Context" href="struts/docs/userguide.html#Velocity Context"/>
- <item name="Context Tools" href="struts/docs/userguide.html#Context Tools"/>
+ <item name="View Tools" href="struts/docs/userguide.html#View Tools"/>
<item name="Velocity and JSP" href="struts/docs/userguide.html#Velocity and JSP"/>
<item name="Velocity vs. JSP" href="struts/docs/userguide.html#Velocity vs. JSP"/>
<item name="Velocity Configuration" href="struts/docs/userguide.html#Velocity Configuration"/>
1.4 +2 -2 jakarta-velocity-tools/struts/xdocs/tools.xml
Index: tools.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/tools.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- tools.xml 4 Apr 2002 09:18:55 -0000 1.3
+++ tools.xml 15 Apr 2002 18:30:28 -0000 1.4
@@ -13,9 +13,9 @@
<section name="VelocityStruts - Reference Documentation">
<p>
- VelocityStruts includes four context tools that provide access
+ VelocityStruts includes four view tools that provide access
to Struts resources from within Velocity templates. This page is the
- starting point to the reference documentation for the context tools.
+ starting point to the reference documentation for the view tools.
Primary audience are the template designers.</p>
<p>
1.2 +4 -4 jakarta-velocity-tools/struts/xdocs/userguide.xml
Index: userguide.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/xdocs/userguide.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- userguide.xml 2 Apr 2002 16:46:30 -0000 1.1
+++ userguide.xml 15 Apr 2002 18:30:28 -0000 1.2
@@ -30,8 +30,8 @@
request/session and application attributes, how to pass data from model to
view.</li>
- <li><strong>Context Tools</strong> How to load context tools, how to access
- context tools, the toolbox.</li>
+ <li><strong>View Tools</strong> How to load view tools, how to access
+ view tools, the toolbox.</li>
<li><strong>Velocity Configuration</strong> Logging, log details, debugging.</li>
@@ -56,7 +56,7 @@
<ul>
<li><a href="http://jakarta.apache.org/velocity/user-guide.html">Velocity User's Guide</a></li>
<li><a href="http://jakarta.apache.org/velocity/vtl-reference-guide.html">Velocity Template Language Reference Guide</a></li>
- <li><a href=".......struts/docs/index.html">Velocity Context Tools for Struts</a></li>
+ <li><a href=".......struts/docs/index.html">Velocity View Tools for Struts</a></li>
</ul>
</section>
@@ -196,7 +196,7 @@
- <section name="Context Tools">
+ <section name="View Tools">
</section>
1.2 +1 -1 jakarta-velocity-tools/tools/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/README.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- README.txt 3 Apr 2002 09:10:03 -0000 1.1
+++ README.txt 15 Apr 2002 18:30:28 -0000 1.2
@@ -1,7 +1,7 @@
R E A D M E
===========
-This package contains a collection of general purpose context tools.
+This package contains a collection of general purpose view tools.
Most tools are optimized for use with an automatic toolbox manager.
1.2 +62 -81 jakarta-velocity-tools/tools/lib/velocity-tools-view-0.6.jar
<<Binary file>>
1.2 +4 -4 jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/DateTool.java
Index: DateTool.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/DateTool.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DateTool.java 3 Apr 2002 09:10:03 -0000 1.1
+++ DateTool.java 15 Apr 2002 18:30:28 -0000 1.2
@@ -62,7 +62,7 @@
import java.util.Calendar;
import java.util.Locale;
-import org.apache.velocity.tools.view.tools.ThreadSafeContextTool;
+import org.apache.velocity.tools.view.tools.ThreadSafeViewTool;
/**
@@ -70,17 +70,17 @@
* objects in Velocity templates.</p>
*
* <p>The tool is tread-safe and implements interface
- * ThreadSafeContextTool. This allows a compatible toolbox
+ * ThreadSafeViewTool. This allows a compatible toolbox
* manager like {@link org.apache.velocity.tools.view.servlet.ServletToolboxManager}
* to automatically load the tool into the context and reuse
* the same instance for the entire runtime.</p>
*
* @author <a href="mailto:sidler@teamup.com">Gabriel Sidler</a>
* @author <a href="mailto:nathan@esha.com">Nathan Bubna</a>
- * @version $Revision: 1.1 $
+ * @version $Revision: 1.2 $
*/
-public class DateTool implements ThreadSafeContextTool
+public class DateTool implements ThreadSafeViewTool
{
1.2 +3 -3 jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/MathTool.java
Index: MathTool.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/MathTool.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- MathTool.java 3 Apr 2002 09:10:03 -0000 1.1
+++ MathTool.java 15 Apr 2002 18:30:28 -0000 1.2
@@ -54,7 +54,7 @@
package org.apache.velocity.tools.tools;
-import org.apache.velocity.tools.view.tools.ThreadSafeContextTool;
+import org.apache.velocity.tools.view.tools.ThreadSafeViewTool;
import java.lang.Math;
@@ -84,10 +84,10 @@
* </ul>
*
* @author <a href="mailto:nathan@esha.com">Nathan Bubna</a>
- * @version $Revision: 1.1 $ $Date: 2002/04/03 09:10:03 $
+ * @version $Revision: 1.2 $ $Date: 2002/04/15 18:30:28 $
*/
-public class MathTool implements ThreadSafeContextTool
+public class MathTool implements ThreadSafeViewTool
{
/**
* @param num1 the first number
1.2 +3 -3 jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/ParameterParser.java
Index: ParameterParser.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/ParameterParser.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ParameterParser.java 3 Apr 2002 09:10:03 -0000 1.1
+++ ParameterParser.java 15 Apr 2002 18:30:28 -0000 1.2
@@ -55,7 +55,7 @@
package org.apache.velocity.tools.tools;
-import org.apache.velocity.tools.view.tools.ThreadSafeContextTool;
+import org.apache.velocity.tools.view.tools.ThreadSafeViewTool;
import javax.servlet.ServletRequest;
@@ -64,10 +64,10 @@
*
* @author <a href="mailto:sidler@teamup.com">Gabriel Sidler</a>
* @author <a href="mailto:nathan@esha.com">Nathan Bubna</a>
- * @version $Revision: 1.1 $ $Date: 2002/04/03 09:10:03 $
+ * @version $Revision: 1.2 $ $Date: 2002/04/15 18:30:28 $
*/
-public class ParameterParser implements ThreadSafeContextTool
+public class ParameterParser implements ThreadSafeViewTool
{
/**
1.2 +14 -14 jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/ToolLoader.java
Index: ToolLoader.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/ToolLoader.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ToolLoader.java 3 Apr 2002 09:10:03 -0000 1.1
+++ ToolLoader.java 15 Apr 2002 18:30:28 -0000 1.2
@@ -55,16 +55,16 @@
package org.apache.velocity.tools.tools;
import org.apache.velocity.tools.view.context.ViewContext;
-import org.apache.velocity.tools.view.tools.ContextContextTool;
-import org.apache.velocity.tools.view.tools.LogEnabledContextToolImpl;
+import org.apache.velocity.tools.view.tools.ContextViewTool;
+import org.apache.velocity.tools.view.tools.LogEnabledViewToolImpl;
import org.apache.velocity.context.Context;
/**
- * <p>A context tool that allows template designers to load
- * other context tools from within the template. Any object
+ * <p>A view tool that allows template designers to load
+ * other view tools from within the template. Any object
* with a public constructor without parameters can be used
- * as a context tool.</p>
+ * as a view tool.</p>
*
* <p>Example: Assuming that an instance of this class has
* been loaded into the Velocity context under key "toolloader",
@@ -84,12 +84,12 @@
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
* @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
*
- * @version $Id: ToolLoader.java,v 1.1 2002/04/03 09:10:03 sidler Exp $
+ * @version $Id: ToolLoader.java,v 1.2 2002/04/15 18:30:28 sidler Exp $
*
*/
-public class ToolLoader extends LogEnabledContextToolImpl
- implements ContextContextTool
+public class ToolLoader extends LogEnabledViewToolImpl
+ implements ContextViewTool
{
// -------------------------------------------- Properties ----------------
@@ -124,10 +124,10 @@
- // --------------------------------------- Interface ContextContextTool ---
+ // --------------------------------------- Interface ContextViewTool ---
/**
- * Returns an initialized instance of this context tool.
+ * Returns an initialized instance of this view tool.
*/
public Object getInstance(Context context)
{
@@ -139,10 +139,10 @@
// -------------------------------------------- Public Utility Methods ----
/**
- * <p>Loads a context tool of class <i>clazz</i> and inserts it
+ * <p>Loads a view tool of class <i>clazz</i> and inserts it
* into the Velocity context with key <i>key</i>. On order to be
- * loadable, context tools must provide a constructor with no
- * parameters. The life cycle of a context tool loaded using
+ * loadable, view tools must provide a constructor with no
+ * parameters. The life cycle of a view tool loaded using
* this method is the current request.</p>
*
* @param key the key used to add the tool to the context
@@ -159,7 +159,7 @@
}
catch (Exception e)
{
- log(ERROR, "Error loading context tool: " + clazz + " with key: " + key + ". " + e);
+ log(ERROR, "Error loading view tool: " + clazz + " with key: " + key + ". " + e);
}
}
1.2 +2 -2 jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/src/java/org/apache/velocity/tools/tools/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 3 Apr 2002 09:10:03 -0000 1.1
+++ package.html 15 Apr 2002 18:30:28 -0000 1.2
@@ -9,8 +9,8 @@
</head>
<body bgcolor="white">
-Contains a collection of reusable, general-purpose Velocity context tools. Where applicable
-tools are optimized to be used in conjunction with a toolbox manager.
+Contains a collection of reusable, general-purpose Velocity view tools. Where
+applicable tools are optimized to be used in conjunction with a toolbox manager.
<!--
##### THIS IS THE TEMPLATE FOR THE PACKAGE DOC COMMENTS. #####
1.2 +1 -1 jakarta-velocity-tools/tools/xdocs/ParameterParser.xml
Index: ParameterParser.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/xdocs/ParameterParser.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ParameterParser.xml 3 Apr 2002 09:10:03 -0000 1.1
+++ ParameterParser.xml 15 Apr 2002 18:30:29 -0000 1.2
@@ -12,7 +12,7 @@
<section name="ParameterParser Reference Documentation">
- <p>Context tool for easy parsing of ServletRequest parameters.</p>
+ <p>View tool for easy parsing of ServletRequest parameters.</p>
<toolinfo>
<version>@@@version@@@, @@@date@@@</version>
1.2 +5 -5 jakarta-velocity-tools/tools/xdocs/ToolLoader.xml
Index: ToolLoader.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/xdocs/ToolLoader.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ToolLoader.xml 3 Apr 2002 09:10:03 -0000 1.1
+++ ToolLoader.xml 15 Apr 2002 18:30:29 -0000 1.2
@@ -13,7 +13,7 @@
<section name="ToolLoader Reference Documentation">
<p>
- A context tool that allows template designers to load context tools
+ A view tool that allows template designers to load view tools
from within the template. Any object with a public constructor without
parameters can be loaded into the context.
</p>
@@ -44,7 +44,7 @@
<method name="load()">
<abstract>
- Loads a context tool and inserts it into the Velocity context.
+ Loads a view tool and inserts it into the Velocity context.
</abstract>
<signature>
@@ -63,11 +63,11 @@
</parameters>
<description>
- <p>Loads a context tool of class <i>class</i> and inserts it
+ <p>Loads a view tool of class <i>class</i> and inserts it
into the Velocity context with key <i>key</i>. On order to be
- loadable, context tools must provide a public constructor with no
+ loadable, view tools must provide a public constructor with no
parameters.</p>
- <p>The life cycle of a context tool loaded using this method is
+ <p>The life cycle of a view tool loaded using this method is
the current template request. The instance is processing of the
current template has been completet.</p>
<p>If the specified class cannot be found or does not have a
1.4 +3 -3 jakarta-velocity-tools/view/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/README.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- README.txt 2 Apr 2002 18:39:30 -0000 1.3
+++ README.txt 15 Apr 2002 18:30:29 -0000 1.4
@@ -4,10 +4,10 @@
This package contains a standalone servlet that can be used for
template rendering in Web applications. It offers automatic population
of the Velocity context and automatic, configurable management of
-context tools, and I18N support. Other efforts within this package are
+view tools, and I18N support. Other efforts within this package are
the development of a toolbox manager and the definition of a set of
-interfaces for context tools, thereby enabling the efficient handling
-and reuse of context tools.
+interfaces for view tools, thereby enabling the efficient handling
+and reuse of view tools.
Build and JAR
1.5 +4 -4 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/context/ChainedContext.java
Index: ChainedContext.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/context/ChainedContext.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ChainedContext.java 15 Apr 2002 10:45:32 -0000 1.4
+++ ChainedContext.java 15 Apr 2002 18:30:29 -0000 1.5
@@ -73,7 +73,7 @@
* <li>puts the request, response, session, and servlet context objects
* into the Velocity context for direct access, and keeps them
* read-only</li>
- * <li>supports a read-only toolbox of context tools</li>
+ * <li>supports a read-only toolbox of view tools</li>
* <li>auto-searches servlet request attributes, session attributes and
* servlet context attribues for objects</li>
* </ul>
@@ -99,7 +99,7 @@
* @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
- * @version $Id: ChainedContext.java,v 1.4 2002/04/15 10:45:32 sidler Exp $
+ * @version $Id: ChainedContext.java,v 1.5 2002/04/15 18:30:29 sidler Exp $
*/
public class ChainedContext extends VelocityContext implements ViewContext
{
@@ -168,9 +168,9 @@
/**
- * <p>Sets the toolbox of context tools.</p>
+ * <p>Sets the toolbox of view tools.</p>
*
- * @param box toolbox of context tools
+ * @param box toolbox of view tools
*/
public void setToolbox(ToolboxContext box)
{
1.5 +3 -3 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/context/ToolboxContext.java
Index: ToolboxContext.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/context/ToolboxContext.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- ToolboxContext.java 2 Apr 2002 17:48:05 -0000 1.4
+++ ToolboxContext.java 15 Apr 2002 18:30:29 -0000 1.5
@@ -59,19 +59,19 @@
import org.apache.velocity.context.Context;
/**
- * <p>Read-only context used to carry a set of context tools.</p>
+ * <p>Read-only context used to carry a set of view tools.</p>
*
* <p>Writes get dropped.</p>
*
* @author <a href="mailto:sidler@apache.org">Gabriel Sidler</a>
* @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
*
- * @version $Id: ToolboxContext.java,v 1.4 2002/04/02 17:48:05 dlr Exp $
+ * @version $Id: ToolboxContext.java,v 1.5 2002/04/15 18:30:29 sidler Exp $
*/
public class ToolboxContext extends VelocityContext
{
/**
- * The collection of context tools in this toolbox.
+ * The collection of view tools in this toolbox.
*/
private Map toolbox;
1.4 +4 -4 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/context/ViewContext.java
Index: ViewContext.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/context/ViewContext.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- ViewContext.java 15 Apr 2002 10:45:32 -0000 1.3
+++ ViewContext.java 15 Apr 2002 18:30:29 -0000 1.4
@@ -62,20 +62,20 @@
/**
- * <p>Objects implementing this interface are passed to context tools
+ * <p>Objects implementing this interface are passed to view tools
* upon initialization by the
*{@link org.apache.velocity.tools.view.servlet.ServletToolboxManager}.</p>
*
- * <p>The interface provides context tools in a servlet environment
+ * <p>The interface provides view tools in a servlet environment
* access to relevant context information, like servlet request, servlet
* context and the velocity context. See
- * {@link org.apache.velocity.tools.view.tools.ServletContextTool} for an
+ * {@link org.apache.velocity.tools.view.tools.ServletViewTool} for an
* example.</p>
*
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
* @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
*
- * @version $Id: ViewContext.java,v 1.3 2002/04/15 10:45:32 sidler Exp $
+ * @version $Id: ViewContext.java,v 1.4 2002/04/15 18:30:29 sidler Exp $
*/
public interface ViewContext
{
1.5 +5 -6 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/i18n/MultiViewsTool.java
Index: MultiViewsTool.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/i18n/MultiViewsTool.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- MultiViewsTool.java 4 Apr 2002 01:53:24 -0000 1.4
+++ MultiViewsTool.java 15 Apr 2002 18:30:29 -0000 1.5
@@ -62,7 +62,7 @@
import org.apache.velocity.context.Context;
import org.apache.velocity.tools.view.context.ViewContext;
-import org.apache.velocity.tools.view.tools.ServletContextTool;
+import org.apache.velocity.tools.view.tools.ServletViewTool;
/**
* <p>Allows for transparent content negotiation in a manner mimicking
@@ -77,7 +77,7 @@
* @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a>
*/
public class MultiViewsTool
- implements ServletContextTool
+ implements ServletViewTool
{
/**
* The key used to search initialization, context, and JVM
@@ -109,7 +109,6 @@
* your application.
*
* @param context The context to use.
- * @see org.apache.velocity.view.tools.ContextTool
*/
protected MultiViewsTool(ViewContext context)
{
@@ -162,7 +161,7 @@
* #parse ($multiviews.findLocalizedResource("footer.vm", "en"))
* </pre></code></blockquote>
*
- * You might also wrap this method using another pull/context tool
+ * You might also wrap this method using another pull/view tool
* which does internationalization/localization/content negation
* for a single point of access.</p>
*
@@ -200,7 +199,7 @@
* Unneccessary cruft required by our interface. Hopefully this
* method will go away soon.
*
- * @see org.apache.velocity.tools.view.tools.ServletContextTool#getInstance(ViewContext)
+ * @see org.apache.velocity.tools.view.tools.ServletViewTool#getInstance(ViewContext)
*/
public Object getInstance(ViewContext context)
{
@@ -212,7 +211,7 @@
* this is merely to signify that it is thread-safe, and can
* actually be used in any scope.
*
- * @see org.apache.velocity.tools.view.tools.ServletContextTool#getDefaultLifecycle()
+ * @see org.apache.velocity.tools.view.tools.ServletViewTool#getDefaultLifecycle()
*/
public String getDefaultLifecycle()
{
1.2 +61 -61 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/servlet/ServletToolboxManager.java
Index: ServletToolboxManager.java
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/servlet/ServletToolboxManager.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ServletToolboxManager.java 2 Apr 2002 16:46:31 -0000 1.1
+++ ServletToolboxManager.java 15 Apr 2002 18:30:29 -0000 1.2
@@ -76,26 +76,26 @@
import org.apache.velocity.tools.view.context.ToolboxContext;
import org.apache.velocity.tools.view.context.ViewContext;
-import org.apache.velocity.tools.view.tools.ServletContextTool;
-import org.apache.velocity.tools.view.tools.LogEnabledContextTool;
-import org.apache.velocity.tools.view.tools.ContextContextTool;
-import org.apache.velocity.tools.view.tools.ThreadSafeContextTool;
+import org.apache.velocity.tools.view.tools.ServletViewTool;
+import org.apache.velocity.tools.view.tools.LogEnabledViewTool;
+import org.apache.velocity.tools.view.tools.ContextViewTool;
+import org.apache.velocity.tools.view.tools.ThreadSafeViewTool;
/**
* <p>A toolbox manager for the servlet environment.</p>
*
* <p>A toolbox manager is responsible for automatically filling the Velocity
- * context with a set of context tools. This class provides the following
+ * 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 context tools (the toolbox) on request</li>
- * <li>handles context tools with different life cycles</li>
- * <li>efficiently reuses context tool instances where possible</li>
- * <li>provides special handling to known classes of context tools</li>
+ * <li>assembles a set of view tools (the toolbox) on request</li>
+ * <li>handles view tools with different life cycles</li>
+ * <li>efficiently reuses view tool instances where possible</li>
+ * <li>provides special handling to known classes of view tools</li>
* <li>supports any class with a public constructor without parameters
- * to be used as a context tool</li>
+ * to be used as a view tool</li>
* </ul>
*
*
@@ -118,26 +118,26 @@
* </toolbox>
* </pre>
* <p>The recommended location for the configuration file is the WEB-INF directory of the
- * web application. Note that some classes of context tools may allow or
+ * web application. Note that some classes of view tools may allow or
* require additional configuration attributes. Please consult the documentation
- * of the context tools for more details.
+ * of the view tools for more details.
*
*
- * <p><strong>Recognized Classes of Context Tools</strong></p>
+ * <p><strong>Recognized Classes of View Tools</strong></p>
* <p>ServletToolboxManager provides special support for the following classes
- * of context tools:
+ * of view tools:
* <dl>
- * <dt>{@link LogEnabledContextTool}</dt>
+ * <dt>{@link LogEnabledViewTool}</dt>
* <dd>Receive a reference to a logger object that enables them to log error
* conditions.</dd>
*
- * <dt>{@link ThreadSafeContextTool}</dt>
+ * <dt>{@link ThreadSafeViewTool}</dt>
* <dd>Instances are considered to be thread-safe. One single instance of
* the tool is re-used the entire runtime. This is much more efficient
* than the default handling (see below)</dd>
*
- * <dt>{@link ServletContextTool}</dt>
- * <dd>Context tools that implement this interface support the additional
+ * <dt>{@link ServletViewTool}</dt>
+ * <dd>View tools that implement this interface support the additional
* configuration attribute <i>lifecycle</i>. This allows an
* application developer to explicitely assign a <i>lifecycle</i> to the tool.
* Supported are the values <code>request</code>, <code>session</code> and
@@ -152,18 +152,18 @@
* <scope>session</scope>
* </tool>
* </pre>
- * Furthermore, context tools of this class get access to the current
+ * Furthermore, view tools of this class get access to the current
* servlet request, the current session and the servlet context.</dd>
*
- * <dt>{@link ContextContextTool}</dt>
- * <dd>Context tools of this class receive a reference to the Velocity
+ * <dt>{@link ContextViewTool}</dt>
+ * <dd>View tools of this class receive a reference to the Velocity
* context.</dd>
* </dl>
*
*
* <p><strong>Default Handling</strong></p>
* <p>Any object with a public constructor without parameters can be used
- * as a context tool. For classes of context tools that are not listed above,
+ * as a view tool. For classes of view tools that are not listed above,
* the following default handling is applied:</p>
* <ul>
* <li>instances are created using a constructor without parameters</li>
@@ -185,7 +185,7 @@
* @author <a href="mailto:nathan@esha.com">Nathan Bubna</a>
* @author <a href="mailto:geirm@apache.org">Geir Magnusson Jr.</a>
*
- * @version $Id: ServletToolboxManager.java,v 1.1 2002/04/02 16:46:31 sidler Exp $
+ * @version $Id: ServletToolboxManager.java,v 1.2 2002/04/15 18:30:29 sidler Exp $
*
*/
public class ServletToolboxManager
@@ -199,7 +199,7 @@
public static final String SESSION_TOOLS_KEY = "org.apache.velocity.tools.view.tools.ServletToolboxManager.SessionTools";
- private ServletContextToolLogger logger;
+ private ServletViewToolLogger logger;
private ServletContext scontext;
private SAXReader saxReader;
@@ -223,7 +223,7 @@
applicationToolsNotInitialized = new ArrayList();
sessionTools = new ArrayList();
requestTools = new ArrayList();
- logger = new ServletContextToolLogger(scontext);
+ logger = new ServletViewToolLogger(scontext);
}
@@ -297,7 +297,7 @@
continue;
}
- // Try to read the tool's lifecycle (specific to ServletContextTool)
+ // Try to read the tool's lifecycle (specific to ServletViewTool)
// First, check of a lifecycle has been configured.
n = e.selectSingleNode(TOOL_LIFECYCLE);
@@ -311,7 +311,7 @@
// Secondly, try to read default lifecycle
try
{
- lifecycle = ((ServletContextTool)obj).getDefaultLifecycle();
+ lifecycle = ((ServletViewTool)obj).getDefaultLifecycle();
}
catch (ClassCastException cce)
{
@@ -321,34 +321,34 @@
log(" Life cycle: " + lifecycle);
//
- // Pass a logger to the tools that implement interface LogEnabledContextTool
+ // Pass a logger to the tools that implement interface LogEnabledViewTool
//
- if (obj instanceof LogEnabledContextTool)
+ if (obj instanceof LogEnabledViewTool)
{
- ((LogEnabledContextTool)obj).setLogger(logger);
- log(" Known interface: LogEnabledContextTool");
+ ((LogEnabledViewTool)obj).setLogger(logger);
+ log(" Known interface: LogEnabledViewTool");
}
//
// Store the tool instance in the appropriate list
//
- // First, handle tools that implement interface ServletContextTool
- // (the interface ThreadSafeContextTool is not considered in this
+ // First, handle tools that implement interface ServletViewTool
+ // (the interface ThreadSafeViewTool is not considered in this
// case because the 'lifecycle' attribute takes precedence over the
// 'thread safe' attribute)
- if (obj instanceof ServletContextTool)
+ if (obj instanceof ServletViewTool)
{
- log(" Known interface: ServletContextTool");
- if (lifecycle.equalsIgnoreCase(ServletContextTool.REQUEST))
+ log(" Known interface: ServletViewTool");
+ if (lifecycle.equalsIgnoreCase(ServletViewTool.REQUEST))
{
requestTools.add(new ToolInfo(key, obj, classname));
}
- else if (lifecycle.equalsIgnoreCase(ServletContextTool.SESSION))
+ else if (lifecycle.equalsIgnoreCase(ServletViewTool.SESSION))
{
sessionTools.add(new ToolInfo(key, obj, classname));
}
- else if (lifecycle.equalsIgnoreCase(ServletContextTool.APPLICATION))
+ else if (lifecycle.equalsIgnoreCase(ServletViewTool.APPLICATION))
{
applicationToolsNotInitialized.add(new ToolInfo(key, obj, classname));
}
@@ -360,30 +360,30 @@
continue;
}
- // Secondly, handle tools that implement interface ContextContextTool
- // (The interface ThreadSafeContextTool is not considered in this case
+ // Secondly, handle tools that implement interface ContextViewTool
+ // (The interface ThreadSafeViewTool is not considered in this case
// because it doesn't matter. A new tool instance is created for every
// request anyway since the Velocity context needs to be passed.)
- if (obj instanceof ContextContextTool)
+ if (obj instanceof ContextViewTool)
{
- log(" Known interface: ContextContextTool");
+ log(" Known interface: ContextViewTool");
// These tools always have a life cycle of 'request'
requestTools.add(new ToolInfo(key, obj, classname));
continue;
}
- // Third, handle tools that implement interface ThreadSafeContextTool.
+ // Third, handle tools that implement interface ThreadSafeViewTool.
// In this case, the one and only instance of the tool is reused the
// entire runtime.
- if (obj instanceof ThreadSafeContextTool)
+ if (obj instanceof ThreadSafeViewTool)
{
- log(" Known interface: ThreadSafeContextTool");
+ log(" Known interface: ThreadSafeViewTool");
applicationToolsNotInitialized.add(new ToolInfo(key, obj, classname));
continue;
}
// Fourth, handle tools that implement no known interface.
- // Unknown context tools are considered not thread-safe and
+ // Unknown view tools are considered not thread-safe and
// therefore a new instance is created for every template processing
// request.
log(" Known interface: None. Apply default handling.");
@@ -424,20 +424,20 @@
ToolInfo info = (ToolInfo)i.next();
Object tool = info.getTool();
- // First, handle tools that implement ServletContextTool and have
+ // First, handle tools that implement ServletViewTool and have
// a defined life cycle of 'application'
- if (tool instanceof ServletContextTool)
+ if (tool instanceof ServletViewTool)
{
applicationTools.put(info.getKey(),
- ((ServletContextTool)tool).getInstance(vcontext));
+ ((ServletViewTool)tool).getInstance(vcontext));
continue;
}
- // Secondly, handle ContextContextTools
+ // Secondly, handle ContextViewTools
// => they never have an 'application' life cycle, => skip
- // Third, handle tools that implement ThreadSafeContextTool
- if (tool instanceof ThreadSafeContextTool)
+ // Third, handle tools that implement ThreadSafeViewTool
+ if (tool instanceof ThreadSafeViewTool)
{
applicationTools.put(info.getKey(), tool);
continue;
@@ -482,12 +482,12 @@
ToolInfo info = (ToolInfo)i.next();
Object tool = info.getTool();
- // Only tools of class ServletContextTool can
+ // Only tools of class ServletViewTool can
// have a life cycle of session.
try
{
stmap.put(info.getKey(),
- ((ServletContextTool)tool).getInstance(vcontext));
+ ((ServletViewTool)tool).getInstance(vcontext));
}
catch(ClassCastException cce)
{
@@ -513,21 +513,21 @@
ToolInfo info = (ToolInfo)i.next();
Object tool = info.getTool();
- // First, handle tools that implement ServletContextTool.
+ // First, handle tools that implement ServletViewTool.
// They are initialized with an instance of ViewContext.
- if (tool instanceof ServletContextTool)
+ if (tool instanceof ServletViewTool)
{
toolbox.put(info.getKey(),
- ((ServletContextTool)(info.getTool())).getInstance(vcontext));
+ ((ServletViewTool)(info.getTool())).getInstance(vcontext));
continue;
}
- // Secondly, handle tools that implement ContextContextTool.
+ // Secondly, handle tools that implement ContextViewTool.
// They are initialized with an instance of Context.
- if (tool instanceof ContextContextTool)
+ if (tool instanceof ContextViewTool)
{
toolbox.put(info.getKey(),
- ((ContextContextTool)(info.getTool())).getInstance((Context)vcontext));
+ ((ContextViewTool)(info.getTool())).getInstance((Context)vcontext));
continue;
}
@@ -553,7 +553,7 @@
/**
- * This class holds a context tool's key and original instance.
+ * This class holds a view tool's key and original instance.
*/
protected final class ToolInfo
{
1.1 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/servlet/ServletViewToolLogger.java
Index: ServletViewToolLogger.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view.servlet;
import javax.servlet.ServletContext;
import org.apache.velocity.tools.view.tools.ViewToolLogger;
/**
* <p>A logger for view tools in a servlet environment.</p>
*
* <p>This class implements interface {@link ViewToolLogger}.
* The logged messages are forwarded to the standard log facilities
* provided by the Servlet API, namely {@link ServletContext#log(String msg)}
*
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
* @version $Id: ServletViewToolLogger.java,v 1.1 2002/04/15 18:30:29 sidler Exp $
*
*/
public class ServletViewToolLogger implements ViewToolLogger
{
/**
* A reference to the servlet context.
*/
private ServletContext ctx;
/**
* <p>Default constructor.</p>
*
* @param ctx A reference to the servlet context of the web
* application.
*/
public ServletViewToolLogger(ServletContext ctx)
{
this.ctx = ctx;
}
/**
* <p>Logs a message to the standard servlet log facility.</p>
*
* @param msg message to be logged, no formatting is applied
*/
public void log(String msg)
{
ctx.log(msg);
}
}
1.2 +1 -1 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/tools/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/tools/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 2 Apr 2002 16:46:31 -0000 1.1
+++ package.html 15 Apr 2002 18:30:29 -0000 1.2
@@ -11,7 +11,7 @@
<body bgcolor="white">
Provides interfaces and abstract classes supporting the construction of
-automatically managed context tools.
+automatically managed view tools.
<!--
1.1 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/tools/ContextViewTool.java
Index: ContextViewTool.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view.tools;
import org.apache.velocity.tools.view.context.ViewContext;
import org.apache.velocity.context.Context;
/**
* <p>An interface for Velocity view tools that need access to the Velocity
* context.</p>
*
* <p>View tools that implement this interface receive special treatment
* by a compatible toolbox manager, e.g.
* {@link org.apache.velocity.tools.view.servlet.ServletToolboxManager}:</p>
* <ul>
* <li>Upon creation of a new instance, the toolbox manager passes
* to the view tool a reference to the Velocity context.</li>
* </ul>
*
* <p>Unlike some other tools, tools that implement this interface do not
* support multiple different life cycles. All implementations of this
* interface are assigned a life cycle of 'request', meaning that the
* tool is valid only for the processing of the currently requested template.
* A new instance is created for every request. The life cycle cannot be
* configured.</p>
*
* <p>Examples of view tools that typically would implement this
* interface are tools like a view tool loader or a context inspector.
*
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
* @version $Id: ContextViewTool.java,v 1.1 2002/04/15 18:30:29 sidler Exp $
*
*/
public interface ContextViewTool
{
/**
* <p>Returns a new instance.</p>
*
* <p>This is effectively a factory method used to create
* object instances for use in templates. It is important
* that only instances obtained from this method are used
* in templates.</p>
*
* @param context a reference to the Velocity context
*/
public Object getInstance(Context context);
}
1.1 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/tools/LogEnabledViewTool.java
Index: LogEnabledViewTool.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view.tools;
/**
* <p>An interface that marks a view tool class as capable of logging.</p>
*
* <p>The only method defined by this interface is
* <code>{@link #setLogger(ViewToolLogger logger)}</code>. This method allows
* a toolbox manager to pass an instance of a logger object to the context
* tool. This logger can be used subsequently to log messages.</p>
*
* <p>The following implementation guidelines are to be noted:</p>
* <ul>
* <li>Implementing this interface by a view tool does not garantuee
* that a logger will be passed. It is up to the implementation of the
* toolbox manager if a logger is passed or not.</li>
* <li>If a logger is passed using setLogger(), it will be passed only
* to one instance of a view tool class. It has to be made sure, that
* a reference to the logger is stored in a static variable, such that
* the logger is available to all instances of the class.</li>
* <li>Logging in view tools typically should be used only for serious
* errors. Most application environments already implement usage
* logging, etc.</li>
* </ul>
*
* @author <a href="mailto:sidler@teamup.com">Gabriel Sidler</a>
*
* @version $Id: LogEnabledViewTool.java,v 1.1 2002/04/15 18:30:29 sidler Exp $
*
*/
public interface LogEnabledViewTool
{
/**
* <p>Sets a logger instance for this class of view tools.</p>
*
* <p>This logger can be used subsequently by instances to to log
* messages to the logging infrastructor of th underlying framework.</p>
*
* @param logger the logger instance to be set
*/
public void setLogger(ViewToolLogger logger);
}
1.1 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/tools/LogEnabledViewToolImpl.java
Index: LogEnabledViewToolImpl.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view.tools;
/**
* <p>An implementation of the {@link LogEnabledViewTool} interface. </p>
*
* <p>This class is intended to be extended by view tools that need
* logging. It implements logging to a logger object passed passed using
* the {@link #setLogger} method. The implementation support three log
* levels ERROR, WARN and INFO and takes care of formatting the log message
* appropriately.</p>
*
* @author <a href="mailto:sidler@teamup.com">Gabriel Sidler</a>
*
* @version $Id: LogEnabledViewToolImpl.java,v 1.1 2002/04/15 18:30:29 sidler Exp $
*
*/
public abstract class LogEnabledViewToolImpl implements LogEnabledViewTool
{
/**
* Constant for error log messages.
*/
public static final int ERROR = 10;
/**
* Constant for warning log messages.
*/
public static final int WARN = 20;
/**
* Constant for informational log messages.
*/
public static final int INFO = 30;
/**
* A reference to the logger.
*/
protected static ViewToolLogger logger;
/**
* <p>Sets a logger instance for this class of view tools. </p>
*
* <p>This logger can be used subsequently by instances to log
* messages to the logging infrastructor of the underlying framework.
* If a logger is never set, the {@link #log(int level, String msg)}
* method will simply do nothing.</p>
*
* @param logger the logger instance to be set
*/
public void setLogger(ViewToolLogger logger)
{
this.logger = logger;
}
/**
* <p>Writes a message to the log. </p>
*
* <p>The message is modified in the following ways before it is
* sent to the logger:</p>
* <ul>
* <li>the class name is prepended</li>
* <li>one of <code>[ERROR]</code>, <code>[WARN]</code>, or
* <code>[INFO]</code> is prepended</li>
* </ul>
* <p>For example, the log message "File not found." would be
* written to the log as:
* <pre>
* org.apache.velocity.tools.tools.toolXY [ERROR] File not found.
* </pre>
* <p>If no logger has been set previously, the method will do nothing.</p>
*
* @param level log level, one of {@link #ERROR}, {@link #WARN} or
* {@link #INFO}
* @param msg log message
*/
public void log(int level, String msg)
{
if (logger != null)
{
if (level == ERROR)
{
logger.log(this.getClass() + ": [ERROR] " + msg);
}
else if (level == WARN)
{
logger.log(this.getClass() + ": [WARN] " + msg);
}
else
{
logger.log(this.getClass() + ": [INFO] " + msg);
}
}
}
}
1.1 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/tools/ServletViewTool.java
Index: ServletViewTool.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view.tools;
import org.apache.velocity.tools.view.context.ViewContext;
/**
* <p>An interface for Velocity view tools in a servlet environment.</p>
*
* <p>View tools that implement this interface receive special treatment
* by a compatible toolbox manager, e.g.
* {@link org.apache.velocity.tools.view.servlet.ServletToolboxManager}:</p>
* <ul>
* <li>The toolbox manager supports three different life cycle models for
* view tools: <i>request</i>, <i>session</i> and <i>application</i>.
* An application developer can choose through configuration of the
* toolbox which of the three life cycle models should be applied to a
* particular tool class. Since not every tool class is capable to be used
* with all of the three livecylce models, it is important to consult the
* tool documentation. See also
* {@link org.apache.velocity.tools.view.servlet.ServletToolboxManager} for
* more information.</li>
* <li>Upon instantiation of a new view tool, the toolbox manager passes
* to the view tool an object of class {@link ViewContext}. This
* gives the view tool access to HttpServletRequest, HttpSession and
* ServletContext.</li>
* </ul>
*
* <p>The three static fields {@link #REQUEST}, {@link #SESSION} and
* {@link #APPLICATION} define constants to be used to specify one of the
* three life cycle models. These constants are used in the toolbox
* configuration file.</p>
*
* <p>Note that view tools that do not need any of the special treatment
* described above, do not need to implement this interface. Please refer to
* the documentation of
* {@link org.apache.velocity.tools.view.servlet.ServletToolboxManager} for
* more information on the default treatment of view tools.</p>
*
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
* @version $Id: ServletViewTool.java,v 1.1 2002/04/15 18:30:29 sidler Exp $
*
*/
public interface ServletViewTool
{
/**
* Constant for a live cycle of <i>request</i>.
*/
public static final String REQUEST = "request";
/**
* Constant for a live cycle of <i>session</i>.
*/
public static final String SESSION = "session";
/**
* Constant for a live cycle of <i>application</i>.
*/
public static final String APPLICATION = "application";
/**
* A new tool object will be instantiated per-request by calling
* this method. A ViewTool is effectively a factory used to
* create objects for use in templates. Some tools may simply return
* themselves from this method, others may instantiate new objects
* to hold the per-request state.
*
* @param context A reference to the Velocity context. Through this
* object, view tools gain access to HttpServletRequest,
* HttpSession and ServletContext.
*/
public Object getInstance(ViewContext context);
/**
* <p>Returns the default life cycle for the view tool. Some
* toolbox managers may allow an application developer to overwrite
* this default life cycle by defining a life cycle attribute in
* the toolbox configuration. An implementation of this interface
* should clearly document if life cycles other than the default
* life cycle is allowed for the tool.</p>
*
* @returns one of {@link #REQUEST}, {@link SESSION} or {@link APPLICATION}.
*/
public String getDefaultLifecycle();
}
1.1 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/tools/ThreadSafeViewTool.java
Index: ThreadSafeViewTool.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view.tools;
/**
* <p>A marker interface that indicates that a view tool is thread-safe. </p>
*
* <p>The handling of thread-safe view tools can be optimized by
* compatible toolbox managers like
* {@link org.apache.velocity.tools.view.servlet.ServletToolboxManager}.
* The same instance of the view tool can be reused for the entire runtime.
* </p>
*
* <p>This class does not define any methods or fields. Thread-safe context
* tools should simply add the 'implements ThreadSafeViewTool' statement
* to the class definition to signal the toolbox manager that it is
* safe to reuse the same instance for multiple template processing requests.
* </p>
*
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
* @version $Id: ThreadSafeViewTool.java,v 1.1 2002/04/15 18:30:29 sidler Exp $
*
*/
public interface ThreadSafeViewTool
{}
1.1 jakarta-velocity-tools/view/src/java/org/apache/velocity/tools/view/tools/ViewToolLogger.java
Index: ViewToolLogger.java
===================================================================
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Velocity", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.velocity.tools.view.tools;
/**
* <p>Defines the interface of a logger object that can be used by context
* tools to log messages to an underlying logging facility. </p>
*
* <p>Implementation of this interface can be thought of as adapters
* between view tools and the logging facilities of a specific
* environment. For example, in servlet environments a logger instance
* would accept log messages from a view tool and write them to the
* Servlet API's logging facility.</p>
*
* @author <a href="mailto:sidler@teamup.com">Gabe Sidler</a>
*
* @version $Id: ViewToolLogger.java,v 1.1 2002/04/15 18:30:29 sidler Exp $
*
*/
public interface ViewToolLogger
{
/**
* <p>Log a message to the logging infrastructure of the environment. </p>
*
* @param msg Message to be logged. The message is passed on as is. No
* formatting, etc. is applied.
*/
public void log(String msg);
}
1.3 +1 -1 jakarta-velocity-tools/view/xdocs/velservlet.xml
Index: velservlet.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/xdocs/velservlet.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- velservlet.xml 4 Apr 2002 09:18:56 -0000 1.2
+++ velservlet.xml 15 Apr 2002 18:30:30 -0000 1.3
@@ -32,7 +32,7 @@
through the Velocity context. It is not necessary to explicitely
populate the Velocity context.</li>
<li>VelocityViewServlet offers toolbox support. It is possible to define a set
- of context tools (view helpers) that are made available to the template
+ of view tools (view helpers) that are made available to the template
designer automatically through the Velcity context.</li>
<li>Velocity log output can be redirected to the log infrastructure
of the Web application. By default, the log is directed to the
1.3 +5 -5 jakarta-velocity-tools/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.xml 4 Apr 2002 09:18:56 -0000 1.2
+++ index.xml 15 Apr 2002 18:30:30 -0000 1.3
@@ -24,11 +24,11 @@
<dl>
<dt><strong><a href="vellibrary.html">VelocityLibrary</a></strong></dt>
<dd>VelocityLibrary is an effort to setup a library of reuseable and well documented
- context tools. Most tools are optimized for use with an automatically managed
+ view tools. Most tools are optimized for use with an automatically managed
toolbox (see VelocityServlet).</dd>
<dt><strong><a href="../struts/docs/index.html">VelocityStruts</a></strong></dt>
- <dd>The VelocityStruts package is a set of context tools, examples and documentation for
+ <dd>The VelocityStruts package is a set of view tools, examples and documentation for
using the Velocity template engine as a view layer technology for the
<a href="http://jakarta.apache.org/struts/">Jakarta Struts</a> web
application framework. It is based on the VelocityServlet project.</dd>
@@ -36,10 +36,10 @@
<dt><strong><a href="../view/docs/velservlet.html">VelocityServlet</a></strong></dt>
<dd>VelocityServlet is a standalone servlet that can be used for template
rendering in Web applications. It offers automatic population of the
- Velocity context and automatic, configurable management of context tools.
+ Velocity context and automatic, configurable management of view tools.
Other efforts within this project are the development of a toolbox manager
- and the definition of a set of interfaces for context tools, thereby enabling the
- efficient handling and reuse of context tools.</dd>
+ and the definition of a set of interfaces for view tools, thereby enabling the
+ efficient handling and reuse of view tools.</dd>
<dt><strong>Utilities</strong></dt>
<dd>When in place, this will be a library of Velocity-related utilities.</dd>
1.4 +1 -1 jakarta-velocity-tools/xdocs/site.dvsl
Index: site.dvsl
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/site.dvsl,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- site.dvsl 2 Apr 2002 16:46:31 -0000 1.3
+++ site.dvsl 15 Apr 2002 18:30:30 -0000 1.4
@@ -1,6 +1,6 @@
-#set( $relative-path = "file://C:/Users/Sidler/VelTools/jakarta-velocity-tools2/" )
+#set( $relative-path = "file://C:/Users/Sidler/VelTools/jakarta-velocity-tools/" )
#set( $body-bg = '#ffffff' )
#set( $body-fg = '#000000' )
1.3 +3 -3 jakarta-velocity-tools/xdocs/vellibrary.xml
Index: vellibrary.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/vellibrary.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- vellibrary.xml 4 Apr 2002 09:18:56 -0000 1.2
+++ vellibrary.xml 15 Apr 2002 18:30:30 -0000 1.3
@@ -13,7 +13,7 @@
<section name="Welcome to the VelocityLibrary Project">
<p>VelocityLibrary is a Velocity subproject that aims to build of collection
- of reusable and well documented context tools.</p>
+ of reusable and well documented view tools.</p>
<p>Emphasis is being put on providing tool documentation that is
suitable for template designers. To achive this goal, a documenation
@@ -24,7 +24,7 @@
developers". Look at the <a href="../struts/docs/MessageTool.html">Struts MessageTool</a> for a good example of the
new documentation format. We are keen on your feedback. </p>
- <p>Your contribution of useful context tools to the VelocityLibrary
+ <p>Your contribution of useful view tools to the VelocityLibrary
project are welcome. See <a href="#Contributions">below</a> for more details.</p>
<p><strong>VelocityLibrary Content:</strong></p>
@@ -45,7 +45,7 @@
for Struts applications.</dd>
<dt><a href="../tools/docs/ToolLoader.html"><strong>ToolLoader</strong></a></dt>
- <dd>A tool allowing template designers to load context tools
+ <dd>A tool allowing template designers to load view tools
from within the template.</dd>
</dl>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [VelTools] Re: recent commits
Posted by Nathan Bubna <na...@esha.com>.
Gabe said:
> First, the change was that I replaced the term "context tool" by "view
tool".
> I was prompted to do this while I worked on the documentation. The reasons
> are these:
>
> - "view tool" is more accurately describing the tools that we use in the
> view layer. They are not specific or dependent on the Velocity context
> but can be used very well with different view technologies.
I personally find "context tool" to be the better term, because it indicates
that the tool is placed/found in the context.
> - I noticed that the term "context tool" is not very wide-spread. People
are
> more familiar with "view helper" or "view tool". "view helper" was too
> chicky for my taste. Therefore, I went with "view tool".
Changing an API that is in use by others based merely on personal taste
without any discussion or consensus is not prudent. You would find me
drastically more open to such changes if you gave me warning and an
opportunity for dissent.
> - Since "context" also has a meaning in the Servlet world, "view tool"
avoids
> some of the ambiguities that we ran into.
both "context" and "view" have meanings in a variety of situations, this is
a non sequitur.
Nathan Bubna
nathan@esha.com
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [VelTools] Re: recent commits
Posted by Gabriel Sidler <si...@teamup.ch>.
Nathan Bubna wrote:
...
> Now, I intend to go through your recent changes and comment as specifically
> as i can on the problems I see. In the meantime, I would appreciate if you
> would be so kind as to explain your recent class name changes and the
> motives behind them.
First, the change was that I replaced the term "context tool" by "view tool".
I was prompted to do this while I worked on the documentation. The reasons
are these:
- "view tool" is more accurately describing the tools that we use in the
view layer. They are not specific or dependent on the Velocity context
but can be used very well with different view technologies.
- I noticed that the term "context tool" is not very wide-spread. People are
more familiar with "view helper" or "view tool". "view helper" was too
chicky for my taste. Therefore, I went with "view tool".
- Since "context" also has a meaning in the Servlet world, "view tool" avoids
some of the ambiguities that we ran into.
Gabe
--
Gabriel Sidler
Software Engineer, Eivycom GmbH, Zurich, Switzerland
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [VelTools] Re: recent commits
Posted by Nathan Bubna <na...@esha.com>.
Gabe said:
> All my recent commits have been small and smallest steps. The requirement
> is obviously that the repository is never inconsistent.
*Never* is not a requirement. It is very easy and acceptable to make
multiple consecutive changes that cause the repository to be inconsistent
for just a few moments. When you go through and change all documentation
and code simultaneously, the commit message becomes huge and difficult to
follow.
> A small change
> can sometimes lead to a large number of changed files. The commit message
> you quoted above has been a simple change in terminology that I applied to
> all files. I don't see how it makes sense to break down such a commit
> into smaller chunks.
Here's a simple way to start. First commit code changes, then right after
that commit the doc changes. That should be easy enough.
[snip]
> > This last change (and others) you've made had absolutely NO consensus
from
> > users or developers. I'm on both lists and saw exactly zero discussion
or
> > agreement on this naming change.
>
> This is really unfounded! I can't be in the spirit of open source projects
> that every little change needs an explicit discussion and approval.
Sorry, but there was really no warning concerning the change of all tool
interfaces to be "view tools" instead of "context tools". Seriously, if I
am wrong on that, please point me to the relevant email(s) so I can see
that, don't just say I'm wrong.
Further, this was not a minor change! you significantly altered the API.
Minor changes are changes to documentation or small implementation changes.
API changes are rarely minor, and this was not such a case. Even if you are
unwilling to seek consensus on something like this, please give warning
ahead of time so that those who disagree with the change have at least an
opportunity to voice opposition before the change is made.
> Regarding this particular case: I would like to emphasize that we had
> an extensive discussion about the next steps. I have summarized the
> discussion and clearly announced to the list what my next planned steps
> are. See
> http://www.mail-archive.com/velocity-dev@jakarta.apache.org/msg05863.html
Yes, i've read that email, and I still have it in my mail folders. But I
saw no discussion of the change from "context tools" to "view tools".
Frankly, I think it is a very poor name change. "View tools" is
meaningless to me. "Context tools" has been the accepted term for classes
placed in the velocity context to serve as utilities for quite some time
now. I think this is a very poor change.
> We had plenty of discussions and I have clearly indicated what my plans
are.
> I am still pursuing that list. The only deviations were some bug fixes
based
> on user feedback. It is certainly true that I don't enjoy these kind of
> discussions with you.
This API change was never "clearly indicated" to me or anyone else to my
knowledge. It is not on that list.
Nathan Bubna
nathan@esha.com
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [VelTools] Re: recent commits
Posted by Gabriel Sidler <si...@teamup.ch>.
Nathan Bubna wrote:
> Gabe committed:
>
>>sidler 02/04/15 11:30:30
>>
>> Modified: . README.txt build.xml
>> struts README.txt
>> struts/examples/struts index.html
>> struts/examples/struts/WEB-INF/lib
>> velocity-tools-library-0.1.jar
>> velocity-tools-view-0.6.jar
>> struts/examples/struts/WEB-INF/src/examples/app2
>> DemoAction.java
>> struts/examples/struts/doc examples.html
>> struts/examples/struts/examples/context_tools
>> mathtool-demo.txt mathtool-demo.vm
>> struts/examples/struts/examples/struts_app2 tool-demo.txt
>> tool-demo.vm
>> struts/lib velocity-tools-view-0.6.jar
>> struts/src/java/org/apache/velocity/tools/struts
>> ErrorsTool.java FormTool.java LinkTool.java
>> MessageTool.java StrutsUtils.java package.html
>> struts/xdocs index.xml menue.xml tools.xml userguide.xml
>> tools README.txt
>> tools/lib velocity-tools-view-0.6.jar
>> tools/src/java/org/apache/velocity/tools/tools
>>
> DateTool.java
>
>> MathTool.java ParameterParser.java ToolLoader.java
>> package.html
>> tools/xdocs ParameterParser.xml ToolLoader.xml
>> view README.txt
>> view/src/java/org/apache/velocity/tools/view/context
>> ChainedContext.java ToolboxContext.java
>> ViewContext.java
>> view/src/java/org/apache/velocity/tools/view/i18n
>> MultiViewsTool.java
>> view/src/java/org/apache/velocity/tools/view/servlet
>> ServletToolboxManager.java
>> view/src/java/org/apache/velocity/tools/view/tools
>> package.html
>> view/xdocs velservlet.xml
>> xdocs index.xml site.dvsl vellibrary.xml
>> Added: view/src/java/org/apache/velocity/tools/view/servlet
>> ServletViewToolLogger.java
>> view/src/java/org/apache/velocity/tools/view/tools
>> ContextViewTool.java LogEnabledViewTool.java
>> LogEnabledViewToolImpl.java ServletViewTool.java
>> ThreadSafeViewTool.java ViewToolLogger.java
>> Removed: view/src/java/org/apache/velocity/tools/view/servlet
>> ServletContextToolLogger.java
>> view/src/java/org/apache/velocity/tools/view/tools
>> ContextContextTool.java ContextToolLogger.java
>> LogEnabledContextTool.java
>> LogEnabledContextToolImpl.java
>> ServletContextTool.java ThreadSafeContextTool.java
>> Log:
>> Replaced the term "context tool" by "view tool" in the documentation and
>> source.
>>
>
> Gabe,
>
> At the risk of repeating myself and others...
>
> Please, please make your commits incremental,
All my recent commits have been small and smallest steps. The requirement
is obviously that the repository is never inconsistent. A small change
can sometimes lead to a large number of changed files. The commit message
you quoted above has been a simple change in terminology that I applied to
all files. I don't see how it makes sense to break down such a commit
into smaller chunks.
> and (even more importantly)
> get a consensus before you do so. This exactly the kind of open source
> behavior that Jakarta Apache projects do *not* desire or encourage!
>
>>>From Jakarta's "Our Mission" page: "The Apache projects are characterized
> by a collaborative, consensus based development process..."
>
> This last change (and others) you've made had absolutely NO consensus from
> users or developers. I'm on both lists and saw exactly zero discussion or
> agreement on this naming change.
This is really unfounded! I can't be in the spirit of open source projects
that every little change needs an explicit discussion and approval. If I,
as one of the initiators and main contributor to the VelTools project,
cannot even apply a name change without an explicity discussion, then we
really can pack and go home. This would be ridiculous, especially considering
the very early stage of this project. I make dozens such minor design decisions
a day. Most of the time nobody cares. If someone cares, there are plenty
of opportunities to bring this up and discuss it. At the end of the day
we need a consensus.
Regarding this particular case: I would like to emphasize that we had
an extensive discussion about the next steps. I have summarized the
discussion and clearly announced to the list what my next planned steps
are. See
http://www.mail-archive.com/velocity-dev@jakarta.apache.org/msg05863.html
> This is something I had meant to address
> this last week, but was rather busy at work. Well, for whatever it's worth
> now, i'm opposed to these name changes.
>
> I'm not ready to give up on this project yet, but i'm certainly being pushed
> in that direction by this kind of behavior. I was quite optimistic after
> how well the struts tools development went, but have become increasingly
> frustrated by your unilateral decisions and commits since that time.
We had plenty of discussions and I have clearly indicated what my plans are.
I am still pursuing that list. The only deviations were some bug fixes based
on user feedback. It is certainly true that I don't enjoy these kind of
discussions with you.
Regarding your commitment to this project: It's about the third time now
that you threaten in some way not to participate anymore. That's up to
you. It's certainly not a constructive way of cooperating. I am tired of
this kind of behavior and I am simply going to ignore it. I am always open
to technical discussions and I did and will value your technical contributions.
Gabe
--
Gabriel Sidler
Software Engineer, Eivycom GmbH, Zurich, Switzerland
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
[VelTools] Re: recent commits
Posted by Nathan Bubna <na...@esha.com>.
Gabe committed:
> sidler 02/04/15 11:30:30
>
> Modified: . README.txt build.xml
> struts README.txt
> struts/examples/struts index.html
> struts/examples/struts/WEB-INF/lib
> velocity-tools-library-0.1.jar
> velocity-tools-view-0.6.jar
> struts/examples/struts/WEB-INF/src/examples/app2
> DemoAction.java
> struts/examples/struts/doc examples.html
> struts/examples/struts/examples/context_tools
> mathtool-demo.txt mathtool-demo.vm
> struts/examples/struts/examples/struts_app2 tool-demo.txt
> tool-demo.vm
> struts/lib velocity-tools-view-0.6.jar
> struts/src/java/org/apache/velocity/tools/struts
> ErrorsTool.java FormTool.java LinkTool.java
> MessageTool.java StrutsUtils.java package.html
> struts/xdocs index.xml menue.xml tools.xml userguide.xml
> tools README.txt
> tools/lib velocity-tools-view-0.6.jar
> tools/src/java/org/apache/velocity/tools/tools
DateTool.java
> MathTool.java ParameterParser.java ToolLoader.java
> package.html
> tools/xdocs ParameterParser.xml ToolLoader.xml
> view README.txt
> view/src/java/org/apache/velocity/tools/view/context
> ChainedContext.java ToolboxContext.java
> ViewContext.java
> view/src/java/org/apache/velocity/tools/view/i18n
> MultiViewsTool.java
> view/src/java/org/apache/velocity/tools/view/servlet
> ServletToolboxManager.java
> view/src/java/org/apache/velocity/tools/view/tools
> package.html
> view/xdocs velservlet.xml
> xdocs index.xml site.dvsl vellibrary.xml
> Added: view/src/java/org/apache/velocity/tools/view/servlet
> ServletViewToolLogger.java
> view/src/java/org/apache/velocity/tools/view/tools
> ContextViewTool.java LogEnabledViewTool.java
> LogEnabledViewToolImpl.java ServletViewTool.java
> ThreadSafeViewTool.java ViewToolLogger.java
> Removed: view/src/java/org/apache/velocity/tools/view/servlet
> ServletContextToolLogger.java
> view/src/java/org/apache/velocity/tools/view/tools
> ContextContextTool.java ContextToolLogger.java
> LogEnabledContextTool.java
> LogEnabledContextToolImpl.java
> ServletContextTool.java ThreadSafeContextTool.java
> Log:
> Replaced the term "context tool" by "view tool" in the documentation and
> source.
Gabe,
At the risk of repeating myself and others...
Please, please make your commits incremental, and (even more importantly)
get a consensus before you do so. This exactly the kind of open source
behavior that Jakarta Apache projects do *not* desire or encourage!
>From Jakarta's "Our Mission" page: "The Apache projects are characterized
by a collaborative, consensus based development process..."
This last change (and others) you've made had absolutely NO consensus from
users or developers. I'm on both lists and saw exactly zero discussion or
agreement on this naming change. This is something I had meant to address
this last week, but was rather busy at work. Well, for whatever it's worth
now, i'm opposed to these name changes.
I'm not ready to give up on this project yet, but i'm certainly being pushed
in that direction by this kind of behavior. I was quite optimistic after
how well the struts tools development went, but have become increasingly
frustrated by your unilateral decisions and commits since that time.
Now, I intend to go through your recent changes and comment as specifically
as i can on the problems I see. In the meantime, I would appreciate if you
would be so kind as to explain your recent class name changes and the
motives behind them.
Nathan Bubna
nathan@esha.com
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>