ScreenTemplateMapper (Apache Turbine 5.1 API)

java.lang.Object
- org.apache.turbine.services.template.mapper.BaseMapper
- - org.apache.turbine.services.template.mapper.BaseTemplateMapper
  - - org.apache.turbine.services.template.mapper.ScreenTemplateMapper

All Implemented Interfaces:

Mapper
```
public class ScreenTemplateMapper
extends BaseTemplateMapper
implements Mapper
```
This is a pretty simple mapper which returns template pathes for a supplied template name. This path can be used by the TemplateEngine to access a certain resource to actually render the template.

Version:

$Id$

Author:

Henning P. Schmiedehausen

- Field Summary
  - Fields inherited from class org.apache.turbine.services.template.mapper.BaseTemplateMapper
    prefix
  - Fields inherited from class org.apache.turbine.services.template.mapper.BaseMapper
    defaultProperty, separator
- Constructor Summary
  
  Constructors
  Constructor Description
  
  ScreenTemplateMapper()
  Default C'tor.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  String doMapping(String template)
  Check, whether the provided name exists.
  - Methods inherited from class org.apache.turbine.services.template.mapper.BaseTemplateMapper
    getDefaultName, getPrefix, setPrefix
  - Methods inherited from class org.apache.turbine.services.template.mapper.BaseMapper
    getCacheSize, getDefaultProperty, getMappedName, getSeparator, init, isUseCache, setCacheSize, setDefaultProperty, setSeparator, setUseCache
  - 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.services.template.mapper.Mapper
    getCacheSize, getDefaultName, getDefaultProperty, getMappedName, getSeparator, init, isUseCache, setCacheSize, setDefaultProperty, setSeparator, setUseCache

- Constructor Detail
  - ScreenTemplateMapper
```
public ScreenTemplateMapper()
```
    Default C'tor. If you use this C'tor, you must use the bean setter to set the various properties needed for this mapper before first usage.
- Method Detail
  - doMapping
```
public String doMapping(String template)
```
    Check, whether the provided name exists. Returns null if the screen does not exist.
    
    Specified by:
    
    doMapping in class BaseMapper
    
    Parameters:
    
    template - The template name.
    
    Returns:
    
    The matching screen name.