org.apache.shale.view.impl
Class DefaultViewControllerMapper

java.lang.Object
  org.apache.shale.view.impl.DefaultViewControllerMapper

All Implemented Interfaces:

ViewControllerMapper

public class DefaultViewControllerMapper
extends Object
implements ViewControllerMapper

DefaultViewControllerMapper is a default implementation of ViewControllerMapper. The following algorithm is implemented:

• Strip any leading slash ("/") character.
• Strip any traling extension (".xxx"), as long as it occurs after any remaining slash ("/") character.
• Convert each instance of a slash ("/") character into a dollar sign ("$") character.
• If the resulting name matches one of the reserved names recognized by the default VariableResolver, prefix it with an underscore character ("_"), to avoid problems loading managed beans.
• If the resulting name starts with a digit character, prefix it with an underscore character("_"), to avoid problems evaluating value binding expressions using it (because this would be treated as a variable name starting with a digit, and that is not allowed by the syntax of expression evaluation).

Examples of correct managed bean names for typical JSF view identifiers, when this mapper is used, would include:

• For a view identifier /mainmenu.jsp, your managed bean name must be mainmenu (leading slash and trailing extension were stripped).
• For a view identifier /customer/details.jsp, your managed bean name must be customer$details (intermediate slash character also converted).
• For a view identifier /header.jsp, your managed bean name must be _header ("header" is a magic JSF variable returning a Map of HTTP headers for the current request, so you cannot use this name for your own managed beans).

Since the managed bean names also need to be valid variable names in the expression language, this mapper implementation imposes certain restrictions on the view identifiers. View identifiers must not contain characters which have reserved meanings in the expression language, such as '-' (minus) or '+' (plus). A best practice while using this mapper is to ensure view identifiers use letters of the English alphabet in upper or lower case, digits from 0 to 9, '$' (dollar signs) and '_' (underscores) only.

$Id: DefaultViewControllerMapper.java 464373 2006-10-16 04:21:54Z rahul $

Constructor Summary

DefaultViewControllerMapper()

Method Summary

String

mapViewId(String viewId) Return the name of the managed bean that serves as the backing bean for the specified view identifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultViewControllerMapper

public DefaultViewControllerMapper()

Method Detail

mapViewId

public String mapViewId(String viewId)

Return the name of the managed bean that serves as the backing bean for the specified view identifier. If no such managed bean name can be determined, return null.

Specified by:

mapViewId in interface ViewControllerMapper

Parameters:

viewId - View identifier for which to identify a backing bean