Mapper

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> apache >> turbine >> services >> template >> [ mapper overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.apache.turbine.services.template.mapper.Mapper

SOURCE |

Download org.apache.turbine.services.template.mapper.Mapper

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.turbine.services.template.mapper
Interface Mapper

All Known Implementing Classes:: ClassMapper, DirectMapper, DirectTemplateMapper, LayoutTemplateMapper, ScreenDefaultTemplateMapper, ScreenTemplateMapper

public interface Mapper

To separate out the various map and search policies for class names and template names, we use classes that implement this interface.

Version:: $Id: Mapper.java 264148 2005-08-29 14:21:04Z henning $

Method Summary

int getCacheSize()
          Get the CacheSize value.

java.lang.String getDefaultName(java.lang.String template)
          Returns the default name for the supplied template name.

java.lang.String getDefaultProperty()
          Get the DefaultProperty value.

java.lang.String getMappedName(java.lang.String template)
          Return the first match name for the given template name.

char getSeparator()
          Get the Separator value.

void init()
          Mapper initialization.

boolean isUseCache()
          Get the UseCache value.

void setCacheSize(int cacheSize)
          Set the CacheSize value.

void setDefaultProperty(java.lang.String defaultProperty)
          Set the DefaultProperty value.

void setSeparator(char separator)
          Set the Separator value.

void setUseCache(boolean useCache)
          Set the UseCache value.

Method Detail

init

public void init()

Mapper initialization.

getCacheSize

public int getCacheSize()

Get the CacheSize value.

setCacheSize

public void setCacheSize(int cacheSize)

Set the CacheSize value.

isUseCache

public boolean isUseCache()

Get the UseCache value.

setUseCache

public void setUseCache(boolean useCache)

Set the UseCache value.

getDefaultProperty

public java.lang.String getDefaultProperty()

Get the DefaultProperty value.

setDefaultProperty

public void setDefaultProperty(java.lang.String defaultProperty)

Set the DefaultProperty value.

getSeparator

public char getSeparator()

Get the Separator value.

setSeparator

public void setSeparator(char separator)

Set the Separator value.

getDefaultName

public java.lang.String getDefaultName(java.lang.String template)

Returns the default name for the supplied template name. Must never return null.

getMappedName

public java.lang.String getMappedName(java.lang.String template)

Return the first match name for the given template name. This method might return null if no possible match can be found.