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 1709648 2015-10-20 17:08:10Z tv $
  Author:
    Dave Bryson, 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
    `TemplateNavigation()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `abstract String` | `buildTemplate(PipelineData pipelineData)` This Builds the WebMacro/FreeMarker/etc template.
    `protected 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 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

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

          protected String doBuild(PipelineData pipelineData)
                            throws Exception

      Calls doBuildTemplate() and then buildTemplate().
      Specified by:
        `doBuild` in class `Navigation`
      Parameters:
        `pipelineData` - Turbine information.
      Returns:
        the content of the navigation module
      Throws:
        `Exception` - a generic exception.

Copyright © 2000-2015 The Apache Software Foundation. All Rights Reserved.