org.apache.turbine.modules.navigations
Class TemplateNavigation

java.lang.Object
  org.apache.turbine.modules.Assembler
      org.apache.turbine.modules.Navigation
          org.apache.turbine.modules.navigations.TemplateNavigation

Direct Known Subclasses:

BaseJspNavigation, VelocityNavigation

public abstract class TemplateNavigation

extends Navigation

Base Template Navigation.

Version:

$Id: TemplateNavigation.java 534527 2007-05-02 16:10:59Z tv $

Author:

Dave Bryson

Constructor Summary

TemplateNavigation()

Method Summary

abstract org.apache.ecs.ConcreteElement	buildTemplate(RunData data) This Builds the WebMacro/FreeMarker/etc template.
protected org.apache.ecs.ConcreteElement	doBuild(RunData data) Calls doBuildTemplate() and then buildTemplate().
protected abstract void	doBuildTemplate(RunData data) WebMacro Navigations extending this class should overide this method to perform any particular business logic and add information to the context.

Methods inherited from class org.apache.turbine.modules.Navigation

build, prepareText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TemplateNavigation

public TemplateNavigation()

Method Detail

doBuildTemplate

protected abstract void doBuildTemplate(RunData data)
                                 throws java.lang.Exception

WebMacro Navigations extending this class should overide this method to perform any particular business logic and add information to the context.

Parameters:

data - Turbine information.

Throws:

java.lang.Exception - a generic exception.

buildTemplate

public abstract org.apache.ecs.ConcreteElement buildTemplate(RunData data)
                                                      throws java.lang.Exception

This Builds the WebMacro/FreeMarker/etc template.

Parameters:

data - Turbine information.

Returns:

A ConcreteElement.

Throws:

java.lang.Exception - a generic exception.

doBuild

protected org.apache.ecs.ConcreteElement doBuild(RunData data)
                                          throws java.lang.Exception

Calls doBuildTemplate() and then buildTemplate().

Specified by:

doBuild in class Navigation

Parameters:

data - Turbine information.

Returns:

A ConcreteElement.

Throws:

java.lang.Exception - a generic exception.