org.springframework.webflow.engine.builder
Class TextToViewSelector

java.lang.Object
  org.springframework.binding.convert.support.AbstractConverter
      org.springframework.binding.convert.support.ConversionServiceAwareConverter
          org.springframework.webflow.engine.builder.TextToViewSelector

All Implemented Interfaces:

org.springframework.binding.convert.Converter, org.springframework.binding.convert.support.ConversionServiceAware

public class TextToViewSelector
extends org.springframework.binding.convert.support.ConversionServiceAwareConverter

Converter that converts an encoded string representation of a view selector into a ViewSelector object that will make selections at runtime.

This converter supports the following encoded forms:

• empty - will result in a NullViewSelector.
• "viewName" - will result in an ApplicationViewSelector that returns an ApplicationView ViewSelection with the provided view name expression.
• "redirect:<viewName>" - will result in an ApplicationViewSelector that returns an FlowExecutionRedirect to a flow execution URL.
• "externalRedirect:<url>" - will result in an ExternalRedirectSelector that returns an ExternalRedirect to a URL.
• "flowRedirect:<flowId>" - will result in a FlowDefinitionRedirectSelector that returns a FlowDefinitionRedirect to a flow.
• "bean:<id>" - will result in usage of a custom ViewSelector bean implementation.

Author:

Keith Donald, Erwin Vervaet

See Also:

ViewSelection, ViewSelector

Field Summary

static java.lang.String	EXTERNAL_REDIRECT_PREFIX Prefix used when the encoded view name wants to specify that a redirect to an external URL is required.
static java.lang.String	FLOW_DEFINITION_REDIRECT_PREFIX Prefix used when the encoded view name wants to specify that a redirect to a flow definition is requred.
static java.lang.String	REDIRECT_PREFIX Prefix used when the encoded view name wants to specify that a redirect is required.

Constructor Summary

TextToViewSelector(FlowServiceLocator flowServiceLocator)
Create a new text to ViewSelector converter.

Method Summary

protected ViewSelector	convertEncodedViewSelector(java.lang.String encodedView) Convert given encoded view into an appropriate view selector.
protected java.lang.Object	doConvert(java.lang.Object source, java.lang.Class targetClass, org.springframework.binding.convert.ConversionContext context)
java.lang.Class[]	getSourceClasses()
java.lang.Class[]	getTargetClasses()

Methods inherited from class org.springframework.binding.convert.support.ConversionServiceAwareConverter

converterFor, fromStringTo, fromStringToAliased, getConversionService, parseExpression, setConversionService

Methods inherited from class org.springframework.binding.convert.support.AbstractConverter

convert, convert, convert, convert

Methods inherited from class java.lang.Object

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

Field Detail

REDIRECT_PREFIX

public static final java.lang.String REDIRECT_PREFIX

Prefix used when the encoded view name wants to specify that a redirect is required. ("redirect:")

See Also:

Constant Field Values

EXTERNAL_REDIRECT_PREFIX

public static final java.lang.String EXTERNAL_REDIRECT_PREFIX

Prefix used when the encoded view name wants to specify that a redirect to an external URL is required. ("externalRedirect:")

See Also:

Constant Field Values

FLOW_DEFINITION_REDIRECT_PREFIX

public static final java.lang.String FLOW_DEFINITION_REDIRECT_PREFIX

Prefix used when the encoded view name wants to specify that a redirect to a flow definition is requred. ("flowRedirect:")

See Also:

Constant Field Values

Constructor Detail

TextToViewSelector

public TextToViewSelector(FlowServiceLocator flowServiceLocator)

Create a new text to ViewSelector converter. Custom ViewSelector implemenations will be looked up using given service locator.

Method Detail

getSourceClasses

public java.lang.Class[] getSourceClasses()

getTargetClasses

public java.lang.Class[] getTargetClasses()

doConvert

protected java.lang.Object doConvert(java.lang.Object source,
                                     java.lang.Class targetClass,
                                     org.springframework.binding.convert.ConversionContext context)
                              throws java.lang.Exception

Specified by:

doConvert in class org.springframework.binding.convert.support.AbstractConverter

Throws:

java.lang.Exception

convertEncodedViewSelector

protected ViewSelector convertEncodedViewSelector(java.lang.String encodedView)

Convert given encoded view into an appropriate view selector.

Parameters:

encodedView - the encoded view selector

Returns:

the view selector