blob: 6b11b711ad2e3f8cc389252ea8ac292435d0df2c [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>VelocityXslLayout.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">Apache Turbine</a> &gt; <a href="index.source.html" class="el_package">org.apache.turbine.modules.layouts</a> &gt; <span class="el_source">VelocityXslLayout.java</span></div><h1>VelocityXslLayout.java</h1><pre class="source lang-java linenums">package org.apache.turbine.modules.layouts;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* &quot;License&quot;); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringReader;
import org.apache.fulcrum.xslt.XSLTService;
import org.apache.turbine.TurbineConstants;
import org.apache.turbine.annotation.TurbineLoader;
import org.apache.turbine.annotation.TurbineService;
import org.apache.turbine.modules.Screen;
import org.apache.turbine.modules.ScreenLoader;
import org.apache.turbine.pipeline.PipelineData;
import org.apache.turbine.util.RunData;
import org.apache.velocity.context.Context;
/**
* This Layout module allows Velocity XML templates to be used as layouts.
* &lt;br&gt;&lt;br&gt;
* Once the (XML) screen and navigation templates have been inserted into
* the layout template the result is transformed with a XSL stylesheet.
* The stylesheet (with the same name than the screen template) is loaded
* and executed by the XSLT service, so it is important that you correctly
* set up your XSLT service. If the named stylsheet does not exist the
* default.xsl stylesheet is executed. If default.xsl does not exist
* the XML is merely echoed.
* &lt;br&gt;&lt;br&gt;
* Since dynamic content is supposed to be primarily located in
* screens and navigations there should be relatively few reasons to
* subclass this Layout.
*
* @author &lt;a href=&quot;mailto:leon@opticode.co.za&quot;&gt;Leon Messerschmidt&lt;/a&gt;
* @author &lt;a href=&quot;mailto:hps@intermeta.de&quot;&gt;Henning P. Schmiedehausen&lt;/a&gt;
* @version $Id$
*/
<span class="nc" id="L55">public class VelocityXslLayout extends VelocityOnlyLayout</span>
{
/** Injected service instance */
@TurbineService
private XSLTService xsltService;
/** Injected loader instance */
@TurbineLoader( Screen.class )
private ScreenLoader screenLoader;
/**
* Build the layout. Also sets the ContentType and Locale headers
* of the HttpServletResponse object.
*
* @param pipelineData Turbine information.
* @throws Exception a generic exception.
*/
@Override
public void doBuild(PipelineData pipelineData)
throws Exception
{
<span class="nc" id="L76"> RunData data = pipelineData.getRunData();</span>
// Get the context needed by Velocity.
<span class="nc" id="L78"> Context context = velocityService.getContext(pipelineData);</span>
<span class="nc" id="L80"> data.getResponse().setContentType(TurbineConstants.DEFAULT_HTML_CONTENT_TYPE);</span>
// Provide objects to Velocity context
<span class="nc" id="L83"> populateContext(pipelineData, context);</span>
// Grab the layout template set in the VelocityPage.
// If null, then use the default layout template
// (done by the TemplateInfo object)
<span class="nc" id="L88"> String templateName = data.getTemplateInfo().getLayoutTemplate();</span>
<span class="nc" id="L90"> log.debug(&quot;Now trying to render layout {}&quot;, templateName);</span>
// Now, generate the layout template.
<span class="nc" id="L93"> String temp = velocityService.handleRequest(context,</span>
prefix + templateName);
// Finally we do a transformation and send the result
// back to the browser
<span class="nc" id="L98"> xsltService.transform(</span>
<span class="nc" id="L99"> data.getTemplateInfo().getScreenTemplate(),</span>
<span class="nc" id="L100"> new StringReader(temp), data.getResponse().getWriter());</span>
<span class="nc" id="L101"> }</span>
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.12.202403310830</span></div></body></html>