BaseJspScreen (Apache Turbine 5.2-SNAPSHOT API)

java.lang.Object
- org.apache.turbine.modules.screens.TemplateScreen
- - org.apache.turbine.modules.screens.BaseJspScreen

All Implemented Interfaces:

Assembler, Screen

Direct Known Subclasses:

JspErrorScreen
```
public class BaseJspScreen
extends TemplateScreen
```
Base JSP Screen that should be subclassed by screens that want to use JSP. Subclasses should override the doBuildTemplate() method.

Version:

$Id$

Author:

John D. McNally, Frank Y. Kim, Henning P. Schmiedehausen, Peter Courcoux

Field Summary
- Fields inherited from class org.apache.turbine.modules.screens.TemplateScreen
  log
- Fields inherited from interface org.apache.turbine.modules.Screen
  CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX

Constructor Summary

Constructors
Constructor Description

BaseJspScreen()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`buildTemplate(PipelineData pipelineData)`	Method that sets up beans and forward the request to the JSP.
`protected void`	`doBuildTemplate(PipelineData pipelineData)`	Method to be overridden by subclasses to include data in beans, etc.

Methods inherited from class org.apache.turbine.modules.screens.TemplateScreen
doBuild, doPostBuildTemplate, doRedirect, doRedirect, setTemplate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.turbine.modules.Screen
build, getLayout, setLayout

- Constructor Detail
  - BaseJspScreen
```
public BaseJspScreen()
```
- Method Detail
  - buildTemplate
```
public String buildTemplate(PipelineData pipelineData)
                     throws Exception
```
    Method that sets up beans and forward the request to the JSP.
    
    Specified by:
    
    buildTemplate in class TemplateScreen
    
    Parameters:
    
    pipelineData - Turbine information.
    
    Returns:
    
    null - the JSP sends the information.
    
    Throws:
    
    Exception - a generic exception.
  - doBuildTemplate
```
protected void doBuildTemplate(PipelineData pipelineData)
                        throws Exception
```
    Method to be overridden by subclasses to include data in beans, etc.
    
    Specified by:
    
    doBuildTemplate in class TemplateScreen
    
    Parameters:
    
    pipelineData - the PipelineData object
    
    Throws:
    
    Exception - a generic exception.