org.mixer2.spring.webmvc

Class Mixer2XhtmlViewResolver

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.view.AbstractCachingViewResolver

org.springframework.web.servlet.view.UrlBasedViewResolver

org.mixer2.spring.webmvc.Mixer2XhtmlViewResolver

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.ViewResolver

public class Mixer2XhtmlViewResolver
extends org.springframework.web.servlet.view.UrlBasedViewResolver

View Resolver for SpringMVC .
your should add dependency for your application .

 
 <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-webmvc</artifactId>
     <version>3.1.2.RELEASE (or higher)</version>
 </dependency>
 
 

Spring MVC configuration Sample

 
 <bean id="mixer2Engine" class="org.mixer2.Mixer2Engine" scope="singleton" />
 <bean class="org.mixer2.spring.webmvc.Mixer2XhtmlViewResolver">
     <property name="order" value="1" />
     <property name="prefix" value="classpath:m2mockup/m2template/" />
     <!-- Also, you can use file system path like "file:/var/foo/"  -->
     <property name="suffix" value=".html" />
     <property name="basePackage" value="com.example.yourproject.web.view" />
     <property name="mixer2Engine" ref="mixer2Engine" />
     
     <!-- Default value is true that means this resolver returns null -->
     <!-- if template file not found and continue to resolve view name -->
     <!-- by another subsequent view resolver. -->
     <!-- Set "false" if you expect FileNotFoundException for unknown view name -->
     <property name="returnNullIfTemplateFileNotFound" value="true" />
     
     <!-- If this resolver can not find the view class, -->
     <!-- returns html template "as is" with defaultView. -->
     <!-- But if use this property, raise ClassNotFoundException .  -->
     <!-- Default value is false. -->
     <property name="raiseErrorIfViewClassNotFound" value="true" />
 </bean>
 
 

Using this ViewResolver, Your controller method can returns template html file path and name without file extension.
See sample below.

 
  @Controller
 public class HelloWorldController {
 
     @Autowired
    protected helloMessageService helloMessageService;
 
     @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String showHello(Model model) {
        String helloMessage = helloMessageService.getMessage();
        model.addAttribute("helloMessage", helloMessage);
        return "foo/bar/helloWorld"; 
    }
 }
 
 

In this case, "foo/bar/helloWorld" will be attached to "com.example.yourproject.web.view.foo.bar.HelloWorldView" class .

AbstractMixer2XhtmlView which is the base class of HelloWorldView loads the file "m2mockup/m2template/foo/bar/helloWorld.html" as a html template and convert it to the instance of org.mixer2.jaxb.xhtml.Html . You can change the html object in HelloWorldView class.

The template file is "prefix" + viewName + "suffix" . See "prefix" and "suffix" property of Mixer2XhtmlViewResolver bean configuration sample above.

If there were no "com.example.yourproject.web.view.foo.bar.HelloWorldView" class in classpath,default view will be created automatically that load the template file. You can not change the the html object. That means the view resolver returns html on template file as is.

Author:

kazuki43zoo, nabedge

See Also:

spring mvc sample, spring mvc sample code

Field Summary

Fields inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

FORWARD_URL_PREFIX, REDIRECT_URL_PREFIX

Fields inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

DEFAULT_CACHE_LIMIT

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
Mixer2XhtmlViewResolver()

Method Summary

Modifier and Type	Method and Description
protected org.springframework.web.servlet.view.AbstractUrlBasedView	buildView(String viewName)
protected boolean	canHandle(String viewName, Locale locale)
protected AbstractMixer2XhtmlView	createDefaultView()
protected String	createUrl(String viewName)
boolean	isRaiseErrorIfViewClassNotFound()
boolean	isReturnNullIfTemplateFileNotFound()
void	setBasePackage(String basePackage)
void	setClassNameSuffix(String classNameSuffix)
void	setDocType(String docType)
void	setMixer2Engine(Mixer2Engine mixer2Engine)
void	setRaiseErrorIfViewClassNotFound(boolean raiseErrorIfViewClassNotFound)
void	setReturnNullIfTemplateFileNotFound(boolean returnNullIfTemplateFileNotFound)
protected String	toViewClassNamePrefix(String viewName)

Methods inherited from class org.springframework.web.servlet.view.UrlBasedViewResolver

createView, getAttributesMap, getCacheKey, getContentType, getExposeContextBeansAsAttributes, getExposedContextBeanNames, getExposePathVariables, getOrder, getPrefix, getRedirectHosts, getRequestContextAttribute, getSuffix, getViewClass, getViewNames, initApplicationContext, isRedirectContextRelative, isRedirectHttp10Compatible, loadView, requiredViewClass, setAttributes, setAttributesMap, setContentType, setExposeContextBeansAsAttributes, setExposedContextBeanNames, setExposePathVariables, setOrder, setPrefix, setRedirectContextRelative, setRedirectHosts, setRedirectHttp10Compatible, setRequestContextAttribute, setSuffix, setViewClass, setViewNames

Methods inherited from class org.springframework.web.servlet.view.AbstractCachingViewResolver

clearCache, getCacheLimit, isCache, isCacheUnresolved, removeFromCache, resolveViewName, setCache, setCacheLimit, setCacheUnresolved

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

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

Constructor Detail

Mixer2XhtmlViewResolver

public Mixer2XhtmlViewResolver()

Method Detail

setMixer2Engine

public void setMixer2Engine(Mixer2Engine mixer2Engine)

setBasePackage

public void setBasePackage(String basePackage)

setClassNameSuffix

public void setClassNameSuffix(String classNameSuffix)

setDocType

public void setDocType(String docType)

isReturnNullIfTemplateFileNotFound

public boolean isReturnNullIfTemplateFileNotFound()

setReturnNullIfTemplateFileNotFound

public void setReturnNullIfTemplateFileNotFound(boolean returnNullIfTemplateFileNotFound)

isRaiseErrorIfViewClassNotFound

public boolean isRaiseErrorIfViewClassNotFound()

setRaiseErrorIfViewClassNotFound

public void setRaiseErrorIfViewClassNotFound(boolean raiseErrorIfViewClassNotFound)

canHandle

protected boolean canHandle(String viewName,
                            Locale locale)

Overrides:

canHandle in class org.springframework.web.servlet.view.UrlBasedViewResolver

buildView

protected org.springframework.web.servlet.view.AbstractUrlBasedView buildView(String viewName)
                                                                       throws Exception

Overrides:

buildView in class org.springframework.web.servlet.view.UrlBasedViewResolver

Throws:

Exception

createUrl

protected String createUrl(String viewName)

toViewClassNamePrefix

protected String toViewClassNamePrefix(String viewName)

createDefaultView

protected AbstractMixer2XhtmlView createDefaultView()