org.springframework.roo.addon.web.mvc.controller.addon.finder

Class WebFinderCommands

java.lang.Object

org.springframework.roo.addon.web.mvc.controller.addon.finder.WebFinderCommands

All Implemented Interfaces:

org.springframework.roo.shell.CommandMarker

@Service
public class WebFinderCommands
extends Object
implements org.springframework.roo.shell.CommandMarker

Commands which provide finder functionality through Spring MVC controllers.

Since:

1.2.0

Author:

Stefan Schmidt, Paula Navarro

Constructor Summary

Constructors

Constructor and Description
WebFinderCommands()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
void	addController(org.springframework.roo.model.JavaType controller, boolean all, String finder, String responseType) This method provides the Command definition to be able to add new finder on controllers.
List<String>	getAllFinderValues(org.springframework.roo.shell.ShellContext context)
List<String>	getAllResponseTypeValues(org.springframework.roo.shell.ShellContext context) This indicator returns all possible values for --responseType parameter.
List<String>	getControllerValues(org.springframework.roo.shell.ShellContext context)
Map<String,ControllerMVCResponseService>	getInstalledControllerMVCResponseTypes() This method gets all implementations of ControllerMVCResponseService interface to be able to locate all installed ControllerMVCResponseService
org.springframework.roo.shell.Converter<org.springframework.roo.model.JavaType>	getJavaTypeConverter() This method obtains JavaType converter to be able to obtain JavaType from strings
org.springframework.roo.project.ProjectOperations	getProjectOperations()
org.springframework.roo.classpath.TypeLocationService	getTypeLocationService()
boolean	isAllParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --all parameter should be visible or not If --finder parameter has been specified, --all parameter will not be visible to prevent conflicts.
boolean	isCommandAvailable()
boolean	isFinderParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --finder parameter should be visible or not If --all parameter has been specified, --finder parameter will not be visible to prevent conflicts.
boolean	isResponseTypeParameterMandatory(org.springframework.roo.shell.ShellContext context) This indicator says if --responseType parameter should be mandatory or not If --all or --finder parameter have not been specified, --responseType parameter will not be mandatory.
boolean	isResponseTypeParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --responseType parameter should be visible or not If --all or --finder parameter have not been specified, --responseType parameter will not be visible to preserve order.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebFinderCommands

public WebFinderCommands()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context)

isCommandAvailable

public boolean isCommandAvailable()

getControllerValues

public List<String> getControllerValues(org.springframework.roo.shell.ShellContext context)

isAllParameterVisible

public boolean isAllParameterVisible(org.springframework.roo.shell.ShellContext context)

This indicator says if --all parameter should be visible or not If --finder parameter has been specified, --all parameter will not be visible to prevent conflicts.

Returns:

isFinderParameterVisible

public boolean isFinderParameterVisible(org.springframework.roo.shell.ShellContext context)

This indicator says if --finder parameter should be visible or not If --all parameter has been specified, --finder parameter will not be visible to prevent conflicts.

Returns:

getAllFinderValues

public List<String> getAllFinderValues(org.springframework.roo.shell.ShellContext context)

isResponseTypeParameterVisible

public boolean isResponseTypeParameterVisible(org.springframework.roo.shell.ShellContext context)

This indicator says if --responseType parameter should be visible or not If --all or --finder parameter have not been specified, --responseType parameter will not be visible to preserve order.

Returns:

isResponseTypeParameterMandatory

public boolean isResponseTypeParameterMandatory(org.springframework.roo.shell.ShellContext context)

This indicator says if --responseType parameter should be mandatory or not If --all or --finder parameter have not been specified, --responseType parameter will not be mandatory.

Returns:

getAllResponseTypeValues

public List<String> getAllResponseTypeValues(org.springframework.roo.shell.ShellContext context)

This indicator returns all possible values for --responseType parameter. Depends of the specified --controller, responseTypes will be filtered to provide only that responseTypes that exists on current controller. Also, only installed response types will be provided.

Parameters:

context -

Returns:

addController

public void addController(org.springframework.roo.model.JavaType controller,
                 boolean all,
                 String finder,
                 String responseType)

This method provides the Command definition to be able to add new finder on controllers.

Parameters:

controller -

all -

finder -

responseType -

getInstalledControllerMVCResponseTypes

public Map<String,ControllerMVCResponseService> getInstalledControllerMVCResponseTypes()

This method gets all implementations of ControllerMVCResponseService interface to be able to locate all installed ControllerMVCResponseService

Returns:

Map with responseTypes identifier and the ControllerMVCResponseService implementation

getProjectOperations

public org.springframework.roo.project.ProjectOperations getProjectOperations()

getJavaTypeConverter

public org.springframework.roo.shell.Converter<org.springframework.roo.model.JavaType> getJavaTypeConverter()

This method obtains JavaType converter to be able to obtain JavaType from strings

Returns:

getTypeLocationService

public org.springframework.roo.classpath.TypeLocationService getTypeLocationService()