org.apache.turbine.modules.navigations

## Class BaseJspNavigation

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

-     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: BaseJspNavigation.java 1709648 2015-10-20 17:08:10Z tv $
  Author:
    John D. McNally, Henning P. Schmiedehausen, Peter Courcoux

- - ### Field Summary

    - ### Fields inherited from class org.apache.turbine.modules.Navigation

      `CACHE_SIZE_DEFAULT, CACHE_SIZE_KEY, NAME, PREFIX`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `BaseJspNavigation()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and 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 org.apache.turbine.modules.Navigation

      `build, getPrefix`

    - ### Methods inherited from class org.apache.turbine.modules.Assembler

      `getRunData`

    - ### Methods inherited from class java.lang.Object

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

- - ### 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.

Copyright © 2000–2018 The Apache Software Foundation. All rights reserved.