Java Doc for DefaultRequestToViewNameTranslator.java in » J2EE » spring-framework-2.0.6 » org » springframework » web » servlet » view » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » J2EE » spring framework 2.0.6 » org.springframework.web.servlet.view

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

org.springframework.web.servlet.view .DefaultRequestToViewNameTranslator

DefaultRequestToViewNameTranslator

public class DefaultRequestToViewNameTranslator implements RequestToViewNameTranslator(Code)

Simply transforms the URI of the incoming request into the view name.

Can be explicitly defined as the "viewNameTranslator" bean in a org.springframework.web.servlet.DispatcherServlet context; else, a plain default instance will be used.

The default transformation simply strips the leading slash and file extension of the URI and returns the result as the view name with the configured DefaultRequestToViewNameTranslator.setPrefix(String) "prefix" and and DefaultRequestToViewNameTranslator.setSuffix(String) "suffix" added as appropriate.

The stripping of the leading slash and file extension can be disabled using the DefaultRequestToViewNameTranslator.setStripLeadingSlash(boolean) "stripLeadingSlash" and DefaultRequestToViewNameTranslator.setStripExtension(boolean) "stripExtension" properties, respectively.

Find below some examples of request to view name translation.

 http://localhost:8080/gamecast/display.html -> display
 http://localhost:8080/gamecast/displayShoppingCart.html -> displayShoppingCart
 http://localhost:8080/gamecast/admin/index.html -> admin/index

author:
   Rob Harrop
since:
   2.0
See Also:   org.springframework.web.servlet.RequestToViewNameTranslator
See Also:   org.springframework.web.servlet.ViewResolver

Method Summary
final public String	getViewName(HttpServletRequest request) Translates the request URI of the incoming HttpServletRequest to the view name based on the configured parameters.
public void	setAlwaysUseFullPath(boolean alwaysUseFullPath) Set if URL lookup should always use the full path within the current servlet context.
public void	setPrefix(String prefix) Set the prefix to prepend to generated view names.
public void	setSeparator(String separator) Set the value that will replace '`/`' as the separator in the view name.
public void	setStripExtension(boolean stripExtension) Set whether or not file extensions should be stripped from the URI when generating the view name.
public void	setStripLeadingSlash(boolean stripLeadingSlash) Set whether or not leading slashes should be stripped from the URI when generating the view name.
public void	setSuffix(String suffix) Set the suffix to append to generated view names.
public void	setUrlDecode(boolean urlDecode) Set if the context path and request URI should be URL-decoded.
public void	setUrlPathHelper(UrlPathHelper urlPathHelper) Set the org.springframework.web.util.UrlPathHelper to use for the resolution of lookup paths.
protected String	transformPath(String lookupPath) Transform the request URI (in the context of the webapp) stripping slashes and extensions, and replacing the separator as required.

Method Detail

getViewName
final public String getViewName(HttpServletRequest request)(Code)
	Translates the request URI of the incoming HttpServletRequest to the view name based on the configured parameters. See Also: org.springframework.web.util.UrlPathHelper.getLookupPathForRequest See Also: DefaultRequestToViewNameTranslator.transformPath

setAlwaysUseFullPath
public void setAlwaysUseFullPath(boolean alwaysUseFullPath)(Code)
	Set if URL lookup should always use the full path within the current servlet context. Else, the path within the current servlet mapping is used if applicable (i.e. in the case of a ".../" servlet mapping in web.xml). Default is "false". Parameters:* alwaysUseFullPath - `true` if URL lookup should always use the full path See Also: org.springframework.web.util.UrlPathHelper.setAlwaysUseFullPath

setPrefix
public void setPrefix(String prefix)(Code)
	Set the prefix to prepend to generated view names. Parameters: prefix - the prefix to prepend to generated view names

setSeparator
public void setSeparator(String separator)(Code)
	Set the value that will replace '`/`' as the separator in the view name. The default behavior simply leaves '`/`' as the separator. Parameters: separator - the desired separator value

setStripExtension
public void setStripExtension(boolean stripExtension)(Code)
	Set whether or not file extensions should be stripped from the URI when generating the view name. Default is "true". Parameters: stripExtension - `true` if file extensions should be stripped

setStripLeadingSlash
public void setStripLeadingSlash(boolean stripLeadingSlash)(Code)
	Set whether or not leading slashes should be stripped from the URI when generating the view name. Default is "true". Parameters: stripLeadingSlash - `true` if leading slashes are to be stripped

setSuffix
public void setSuffix(String suffix)(Code)
	Set the suffix to append to generated view names. Parameters: suffix - the suffix to append to generated view names

setUrlDecode

public void setUrlDecode(boolean urlDecode)(Code)

Set if the context path and request URI should be URL-decoded. Both are returned undecoded by the Servlet API, in contrast to the servlet path.

Uses either the request encoding or the default encoding according to the Servlet spec (ISO-8859-1).

Note: Setting this to "true" requires JDK 1.4 if the encoding differs from the VM's platform default encoding, as JDK 1.3's URLDecoder class does not offer a way to specify the encoding.
Parameters:
urlDecode - true if the context path and request URI should be URL-decoded
See Also: org.springframework.web.util.UrlPathHelper.setUrlDecode

setUrlPathHelper
public void setUrlPathHelper(UrlPathHelper urlPathHelper)(Code)
	Set the org.springframework.web.util.UrlPathHelper to use for the resolution of lookup paths. Use this to override the default UrlPathHelper with a custom subclass, or to share common UrlPathHelper settings across multiple web components. Parameters: urlPathHelper - the desired helper throws: IllegalArgumentException - if the supplied UrlPathHelper is `null`

transformPath
protected String transformPath(String lookupPath)(Code)
	Transform the request URI (in the context of the webapp) stripping slashes and extensions, and replacing the separator as required. Parameters: lookupPath - the lookup path for the current request,as determined by the UrlPathHelper the transformed path, with slashes and extensions strippedif desired

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.