Google Git
Sign in
apache / struts-site / refs/heads/asf-site / . / output / tag-developers / cewolf-charts-using-velocity-templates.html
blob: 3fe4731284e2db907b4c7ce938535059f730719c [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="Date-Revision-yyyymmdd" content="20140918"/>
<meta http-equiv="Content-Language" content="en"/>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Tag Developers Guide</title>
<link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css">
<link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet">
<link href="/css/main.css" rel="stylesheet">
<link href="/css/custom.css" rel="stylesheet">
<link href="/css/syntax.css" rel="stylesheet">
<script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script>
<script type="text/javascript" src="/js/community.js"></script>
<!-- Matomo -->
<script>
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
/* We explicitly disable cookie tracking to avoid privacy issues */
_paq.push(['disableCookies']);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="//analytics.apache.org/";
_paq.push(['setTrackerUrl', u+'matomo.php']);
_paq.push(['setSiteId', '41']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Matomo Code -->
</head>
<body>
<a href="https://github.com/apache/struts" class="github-ribbon">
<img decoding="async" loading="lazy" style="position: absolute; right: 0; border: 0;" width="149" height="149" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_red_aa0000.png?resize=149%2C149" class="attachment-full size-full" alt="Fork me on GitHub" data-recalc-dims="1">
</a>
<header>
<nav>
<div role="navigation" class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle">
Menu
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a>
</div>
<div id="struts-menu" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Home<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/index.html">Welcome</a></li>
<li><a href="/download.cgi">Download</a></li>
<li><a href="/releases.html">Releases</a></li>
<li><a href="/announce-2024.html">Announcements</a></li>
<li><a href="http://www.apache.org/licenses/">License</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
<li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Support<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/mail.html">User Mailing List</a></li>
<li><a href="https://issues.apache.org/jira/browse/WW">Issue Tracker</a></li>
<li><a href="/security.html">Reporting Security Issues</a></li>
<li><a href="/commercial-support.html">Commercial Support</a></li>
<li class="divider"></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Migration+Guide">Version Notes</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Security+Bulletins">Security Bulletins</a></li>
<li class="divider"></li>
<li><a href="/maven/project-info.html">Maven Project Info</a></li>
<li><a href="/maven/struts2-core/dependencies.html">Struts Core Dependencies</a></li>
<li><a href="/maven/struts2-plugins/modules.html">Plugin Dependencies</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Documentation<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/birdseye.html">Birds Eye</a></li>
<li><a href="/primer.html">Key Technologies</a></li>
<li><a href="/kickstart.html">Kickstart FAQ</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/Home">Wiki</a></li>
<li class="divider"></li>
<li><a href="/getting-started/">Getting Started</a></li>
<li><a href="/security/">Security Guide</a></li>
<li><a href="/core-developers/">Core Developers Guide</a></li>
<li><a href="/tag-developers/">Tag Developers Guide</a></li>
<li><a href="/maven-archetypes/">Maven Archetypes</a></li>
<li><a href="/plugins/">Plugins</a></li>
<li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li>
<li><a href="/tag-developers/tag-reference.html">Tag reference</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/WW/FAQs">FAQs</a></li>
<li><a href="http://cwiki.apache.org/S2PLUGINS/home.html">Plugin registry</a></li>
</ul>
</li>
<li class="dropdown">
<a data-toggle="dropdown" href="#" class="dropdown-toggle">
Contributing<b class="caret"></b>
</a>
<ul class="dropdown-menu">
<li><a href="/youatstruts.html">You at Struts</a></li>
<li><a href="/helping.html">How to Help FAQ</a></li>
<li><a href="/dev-mail.html">Development Lists</a></li>
<li class="divider"></li>
<li><a href="/submitting-patches.html">Submitting patches</a></li>
<li><a href="/builds.html">Source Code and Builds</a></li>
<li><a href="/coding-standards.html">Coding standards</a></li>
<li><a href="/contributors/">Contributors Guide</a></li>
<li class="divider"></li>
<li><a href="/release-guidelines.html">Release Guidelines</a></li>
<li><a href="/bylaws.html">PMC Charter</a></li>
<li><a href="/volunteers.html">Volunteers</a></li>
<li><a href="https://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li>
<li><a href="/updating-website.html">Updating the website</a></li>
</ul>
</li>
<li class="apache"><a href="http://www.apache.org/"><img src="/img/apache.png"></a></li>
</ul>
</div>
</div>
</div>
</nav>
</header>
<article class="container">
<section class="col-md-12">
<a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/cewolf-charts-using-velocity-templates.md" title="Edit this page on GitHub">Edit on GitHub</a>
<h1 id="cewolf-charts-using-velocity-templates">CeWolf charts using Velocity templates</h1>
<h2 id="setup-cewolf">Setup CeWolf</h2>
<p><strong>This currently only works with the most recent CVS version of WebWork but should be available in the upcoming 2.0 beta2</strong></p>
<ol>
<li>
<p>Go to <a href="http://cewolf.sourceforge.net">http://cewolf.sourceforge.net</a> and grab a stable release of CeWolf (at the time of writing, the unstable builds do not work with WebWork).</p>
</li>
<li>
<p>Edit your webwork.properties file and add “de.laures.cewolf.taglib.tags” to the property “webwork.velocity.tag.path”</p>
</li>
</ol>
<p>Lastly add the CeWolf servlet to web.xml:</p>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
<span class="nt">&lt;servlet&gt;</span>
<span class="nt">&lt;servlet-name&gt;</span>CewolfServlet<span class="nt">&lt;/servlet-name&gt;</span>
<span class="nt">&lt;servlet-class&gt;</span>de.laures.cewolf.CewolfRenderer<span class="nt">&lt;/servlet-class&gt;</span>
<span class="nt">&lt;/servlet&gt;</span>
<span class="nt">&lt;servlet-mapping&gt;</span>
<span class="nt">&lt;servlet-name&gt;</span>CewolfServlet<span class="nt">&lt;/servlet-name&gt;</span>
<span class="nt">&lt;url-pattern&gt;</span>/cewolf/*<span class="nt">&lt;/url-pattern&gt;</span>
<span class="nt">&lt;/servlet-mapping&gt;</span>
</code></pre></div></div>
<h2 id="create-a-datasetproducer">Create a DatasetProducer</h2>
<p>This is the default DatasetProducer from the CeWolf tutorial.</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
<span class="kn">import</span> <span class="nn">java.io.Serializable</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">java.util.Date</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">java.util.Map</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.jfree.data.DefaultCategoryDataset</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">de.laures.cewolf.DatasetProduceException</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">de.laures.cewolf.DatasetProducer</span><span class="o">;</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">PageViewCountData</span> <span class="kd">implements</span> <span class="nc">DatasetProducer</span><span class="o">,</span> <span class="nc">Serializable</span> <span class="o">{</span>
<span class="c1">// These values would normally not be hard coded but produced by</span>
<span class="c1">// some kind of data source like a database or a file</span>
<span class="kd">private</span> <span class="kd">final</span> <span class="nc">String</span><span class="o">[]</span> <span class="n">categories</span> <span class="o">=</span> <span class="o">{</span><span class="s">"mon"</span><span class="o">,</span> <span class="s">"tue"</span><span class="o">,</span> <span class="s">"wen"</span><span class="o">,</span> <span class="s">"thu"</span><span class="o">,</span> <span class="s">"fri"</span><span class="o">,</span> <span class="s">"sat"</span><span class="o">,</span> <span class="s">"sun"</span><span class="o">};</span>
<span class="kd">private</span> <span class="kd">final</span> <span class="nc">String</span><span class="o">[]</span> <span class="n">seriesNames</span> <span class="o">=</span> <span class="o">{</span><span class="s">"cewolfset.jsp"</span><span class="o">,</span> <span class="s">"tutorial.jsp"</span><span class="o">,</span> <span class="s">"testpage.jsp"</span><span class="o">,</span> <span class="s">"performancetest.jsp"</span><span class="o">};</span>
<span class="kd">private</span> <span class="kd">final</span> <span class="nc">Integer</span><span class="o">[]</span> <span class="o">[]</span> <span class="n">values</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">Integer</span><span class="o">[</span><span class="nl">OS:</span><span class="n">seriesNames</span><span class="o">.</span><span class="na">length</span><span class="o">]</span> <span class="o">[</span><span class="nl">OS:</span><span class="n">categories</span><span class="o">.</span><span class="na">length</span><span class="o">];</span>
<span class="kd">public</span> <span class="nc">Object</span> <span class="nf">produceDataset</span><span class="o">(</span><span class="nc">Map</span> <span class="n">params</span><span class="o">)</span> <span class="kd">throws</span> <span class="nc">DatasetProduceException</span> <span class="o">{</span>
<span class="nc">DefaultCategoryDataset</span> <span class="n">dataset</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">DefaultCategoryDataset</span><span class="o">();</span>
<span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">series</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">series</span> <span class="o">&lt;</span> <span class="n">seriesNames</span><span class="o">.</span><span class="na">length</span><span class="o">;</span> <span class="n">series</span> <span class="o">++)</span> <span class="o">{</span>
<span class="kt">int</span> <span class="n">lastY</span> <span class="o">=</span> <span class="o">(</span><span class="kt">int</span><span class="o">)(</span><span class="nc">Math</span><span class="o">.</span><span class="na">random</span><span class="o">()</span> <span class="o">*</span> <span class="mi">1000</span> <span class="o">+</span> <span class="mi">1000</span><span class="o">);</span>
<span class="k">for</span> <span class="o">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="o">;</span> <span class="n">i</span> <span class="o">&lt;</span> <span class="n">categories</span><span class="o">.</span><span class="na">length</span><span class="o">;</span> <span class="n">i</span><span class="o">++)</span> <span class="o">{</span>
<span class="kd">final</span> <span class="kt">int</span> <span class="n">y</span> <span class="o">=</span> <span class="n">lastY</span> <span class="o">+</span> <span class="o">(</span><span class="kt">int</span><span class="o">)(</span><span class="nc">Math</span><span class="o">.</span><span class="na">random</span><span class="o">()</span> <span class="o">*</span> <span class="mi">200</span> <span class="o">-</span> <span class="mi">100</span><span class="o">);</span>
<span class="n">lastY</span> <span class="o">=</span> <span class="n">y</span><span class="o">;</span>
<span class="n">dataset</span><span class="o">.</span><span class="na">addValue</span><span class="o">((</span><span class="kt">double</span><span class="o">)</span><span class="n">y</span><span class="o">,</span> <span class="n">seriesNames</span><span class="o">[</span><span class="nl">OS:</span><span class="n">series</span><span class="o">],</span> <span class="n">categories</span><span class="o">[</span><span class="n">i</span><span class="o">]);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="k">return</span> <span class="n">dataset</span><span class="o">;</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kt">boolean</span> <span class="nf">hasExpired</span><span class="o">(</span><span class="nc">Map</span> <span class="n">params</span><span class="o">,</span> <span class="nc">Date</span> <span class="n">since</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="o">(</span><span class="nc">System</span><span class="o">.</span><span class="na">currentTimeMillis</span><span class="o">()</span> <span class="o">-</span> <span class="n">since</span><span class="o">.</span><span class="na">getTime</span><span class="o">())</span> <span class="o">&gt;</span> <span class="mi">5000</span><span class="o">;</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="nc">String</span> <span class="nf">getProducerId</span><span class="o">()</span> <span class="o">{</span>
<span class="k">return</span> <span class="s">"PageViewCountData DatasetProducer"</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div></div>
<h2 id="create-the-velocity-template">Create the Velocity template</h2>
<p>With the new WebWork refactorings, nested JSP tags with arbitrary parameters can be used, so we convert the CeWolf tutorial JSP script to Velocity.</p>
<div class="language-jsp highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
<span class="nt">&lt;jsp:useBean </span><span class="na">id=</span><span class="s">"pageViews"</span><span class="na"> class=</span><span class="s">"de.laures.cewolf.example.PageViewCountData"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;cewolf:chart
</span><span class="na">id=</span><span class="s">"line"</span><span class="na">
title=</span><span class="s">"Page View Statistics"</span><span class="na">
type=</span><span class="s">"line"</span><span class="na">
xaxislabel=</span><span class="s">"Page"</span><span class="na">
yaxislabel=</span><span class="s">"Views"</span><span class="nt">&gt;</span>
<span class="nt">&lt;cewolf:data&gt;</span>
<span class="nt">&lt;cewolf:producer </span><span class="na">id=</span><span class="s">"pageViews"</span><span class="nt">/&gt;</span>
<span class="nt">&lt;/cewolf:data&gt;</span>
<span class="nt">&lt;/cewolf:chart&gt;</span>
<span class="nt">&lt;cewolf:img </span><span class="na">chartid=</span><span class="s">"line"</span><span class="na"> renderer=</span><span class="s">"cewolf"</span><span class="na"> width=</span><span class="s">"400"</span><span class="na"> height=</span><span class="s">"300"</span><span class="nt">/&gt;</span>
</code></pre></div></div>
<p>In Velocity it looks like this:</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>
#set( $pageViews = $stack.findValue("new com.PageViewCountData()") )
$req.session.setAttribute("pageViews", $pageViews )
#bodytag( SimpleChart "id=line" "title=Page View Statistics" "type=line" "xaxislabel=Page" "yaxslabel=Views" )
#bodytag( Data )
#tag( Producer "id=pageViews" )
#end
#end
#tag( ChartImg "chartid=line" "renderer=cewolf" "width=400" "height=300" )
</code></pre></div></div>
<p>As you may notice, CeWolf looks up it’s DatasetProducer in the request attributes - it has no knowledge of the Velocity context. That’s why we call $req.session.setAttribute(). The other attributes (such as the chartid) will be set by CeWolf, so we don’t need to care about them.</p>
<h2 id="setup-an-action-to-disply-the-template">Setup an action to disply the template</h2>
<p>Now you should be able to fire up an action in the usual way with this template as the result and a nice chart should appear.</p>
</section>
</article>
<footer class="container">
<div class="col-md-12">
Copyright &copy; 2000-2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>.
Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are
trademarks of The Apache Software Foundation. All Rights Reserved.
</div>
<div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/">SoftwareMill</a>.</div>
</footer>
<script>!function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (!d.getElementById(id)) {
js = d.createElement(s);
js.id = id;
js.src = "//platform.twitter.com/widgets.js";
fjs.parentNode.insertBefore(js, fjs);
}
}(document, "script", "twitter-wjs");</script>
<script src="https://apis.google.com/js/platform.js" async="async" defer="defer"></script>
<div id="fb-root"></div>
<script>(function (d, s, id) {
var js, fjs = d.getElementsByTagName(s)[0];
if (d.getElementById(id)) return;
js = d.createElement(s);
js.id = id;
js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1";
fjs.parentNode.insertBefore(js, fjs);
}(document, 'script', 'facebook-jssdk'));</script>
</body>
</html>