BaseJspNavigation (Apache Turbine 5.1 API)

java.lang.Object
- org.apache.turbine.modules.navigations.TemplateNavigation
- - org.apache.turbine.modules.navigations.BaseJspNavigation

All Implemented Interfaces:

Assembler, Navigation
```
public class BaseJspNavigation
extends TemplateNavigation
```
Base JSP navigation that should be subclassed by Navigation that want to use JSP. Subclasses should override the doBuildTemplate() method.

Version:

$Id$

Author:

John D. McNally, Henning P. Schmiedehausen, Peter Courcoux

Field Summary
- Fields inherited from interface org.apache.turbine.modules.Navigation
  CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX

Constructor Summary

Constructors
Constructor Description

BaseJspNavigation()

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.navigations.TemplateNavigation
doBuild

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.Navigation
build

- Constructor Detail
  - BaseJspNavigation
```
public BaseJspNavigation()
```
- Method Detail
  - 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 TemplateNavigation
    
    Parameters:
    
    pipelineData - the PipelineData object
    
    Throws:
    
    Exception - a generic exception.
  - 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 TemplateNavigation
    
    Parameters:
    
    pipelineData - the PipelineData object
    
    Returns:
    
    null - the JSP sends the information
    
    Throws:
    
    Exception - a generic exception.