TemplateNavigation (Apache Turbine 5.1 API)

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

All Implemented Interfaces:

Assembler, Navigation

Direct Known Subclasses:

BaseJspNavigation, VelocityNavigation
```
public abstract class TemplateNavigation
extends Object
implements Navigation
```
Base Template Navigation.

Version:

$Id$

Author:

Dave Bryson, 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

TemplateNavigation()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract String`	`buildTemplate(PipelineData pipelineData)`	This Builds the WebMacro/FreeMarker/etc template.
`String`	`doBuild(PipelineData pipelineData)`	Calls doBuildTemplate() and then buildTemplate().
`protected abstract void`	`doBuildTemplate(PipelineData pipelineData)`	WebMacro Navigations extending this class should override this method to perform any particular business logic and add information to the context.

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
  - TemplateNavigation
```
public TemplateNavigation()
```
- Method Detail
  - doBuildTemplate
```
protected abstract void doBuildTemplate(PipelineData pipelineData)
                                 throws Exception
```
    WebMacro Navigations extending this class should override this method to perform any particular business logic and add information to the context.
    
    Parameters:
    
    pipelineData - Turbine information.
    
    Throws:
    
    Exception - a generic exception.
  - buildTemplate
```
public abstract String buildTemplate(PipelineData pipelineData)
                              throws Exception
```
    This Builds the WebMacro/FreeMarker/etc template.
    
    Parameters:
    
    pipelineData - Turbine information.
    
    Returns:
    
    the content of the navigation module
    
    Throws:
    
    Exception - a generic exception.
  - doBuild
```
public String doBuild(PipelineData pipelineData)
               throws Exception
```
    Calls doBuildTemplate() and then buildTemplate().
    
    Specified by:
    
    doBuild in interface Navigation
    
    Parameters:
    
    pipelineData - Turbine information.
    
    Returns:
    
    the content of the navigation module
    
    Throws:
    
    Exception - a generic exception.