NavigationLoader (Apache Turbine 5.1 API)

java.lang.Object
- org.apache.turbine.modules.GenericLoader<Navigation>
- - org.apache.turbine.modules.NavigationLoader

All Implemented Interfaces:

Loader<Navigation>
```
public class NavigationLoader
extends GenericLoader<Navigation>
```
The purpose of this class is to allow one to load and execute Navigation modules.

Version:

$Id$

Author:

Dave Bryson, Henning P. Schmiedehausen, Peter Courcoux

Field Summary
- Fields inherited from class org.apache.turbine.modules.GenericLoader
  ab

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`eval(PipelineData pipelineData, String name)`	Attempts to load and execute the external Navigation.
`void`	`exec(PipelineData pipelineData, String name)`	Attempts to load and execute the external Navigation.
`static NavigationLoader`	`getInstance()`	The method through which this class is accessed.

Methods inherited from class org.apache.turbine.modules.GenericLoader
getAssembler, getAssembler, getBasePackage, getCacheSize, getPackages, reload, setReload

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - eval
```
public String eval(PipelineData pipelineData,
                   String name)
            throws Exception
```
    Attempts to load and execute the external Navigation. This is used when you want to execute a Navigation which returns its output via a MultiPartElement instead of out the data.getPage() value. This allows you to easily chain the execution of Navigation modules together.
    
    Parameters:
    
    pipelineData - Turbine information.
    
    name - Name of object that will execute the navigation.
    
    Returns:
    
    the navigation module output
    
    Throws:
    
    Exception - a generic exception.
  - exec
```
public void exec(PipelineData pipelineData,
                 String name)
          throws Exception
```
    Attempts to load and execute the external Navigation.
    
    Specified by:
    
    exec in class GenericLoader<Navigation>
    
    Parameters:
    
    pipelineData - Turbine information.
    
    name - Name of object instance.
    
    Throws:
    
    Exception - a generic exception.
  - getInstance
```
public static NavigationLoader getInstance()
```
    The method through which this class is accessed.
    
    Returns:
    
    The single instance of this class.