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, Sergio Clares

Constructor Summary

Constructors

Constructor and Description
WebFinderCommands()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
void	addController(org.springframework.roo.model.JavaType entity, boolean all, String queryMethod, String responseType, org.springframework.roo.model.JavaPackage controllerPackage, String pathPrefix) This method provides the Command definition to be able to add new finder on controllers.
List<String>	getAllQueryMethodValues(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>	getEntityValues(org.springframework.roo.shell.ShellContext context)
List<String>	getFinders(org.springframework.roo.model.JavaType entity, ControllerMVCResponseService controllerResponseType) Get all finder names associated to an entity
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 --entity parameter has been specified, --all parameter will not be visible to prevent conflicts.
boolean	isCommandAvailable()
boolean	isEntityParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --entity parameter should be visible or not If --all parameter has been specified, --entity parameter will not be visible to prevent conflicts.
boolean	isPackageParameterVisible(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.
boolean	isPackageRequired(org.springframework.roo.shell.ShellContext shellContext) This indicator says if --package parameter should be visible or not.
boolean	isPathPrefixParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --pathPrefix parameter should be visible or not If --all or --entity parameter have not been specified, --pathPrefix parameter will not be visible to preserve order.
boolean	isQueryMethodParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --queryMethod parameter should be visible or not If --entity parameter has been specified, --queryMethod parameter will be visible.
boolean	isResponseTypeParameterVisible(org.springframework.roo.shell.ShellContext context) This indicator says if --responseType parameter should be visible or not If --all or --entity 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()

isEntityParameterVisible

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

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

Returns:

getEntityValues

public List<String> getEntityValues(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 --entity parameter has been specified, --all parameter will not be visible to prevent conflicts.

Returns:

isQueryMethodParameterVisible

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

This indicator says if --queryMethod parameter should be visible or not If --entity parameter has been specified, --queryMethod parameter will be visible.

Returns:

getAllQueryMethodValues

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

isPackageParameterVisible

public boolean isPackageParameterVisible(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:

isPackageRequired

public boolean isPackageRequired(org.springframework.roo.shell.ShellContext shellContext)

This indicator says if --package parameter should be visible or not. If project has more than one 'application' modules (which contain one @SpringBootApplication), package will be mandatory.

Parameters:

shellContext -

Returns:

isResponseTypeParameterVisible

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

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

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:

isPathPrefixParameterVisible

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

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

Returns:

addController

public void addController(org.springframework.roo.model.JavaType entity,
                          boolean all,
                          String queryMethod,
                          String responseType,
                          org.springframework.roo.model.JavaPackage controllerPackage,
                          String pathPrefix)

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

Parameters:

controller -

all -

finder -

responseType -

getFinders

public List<String> getFinders(org.springframework.roo.model.JavaType entity,
                               ControllerMVCResponseService controllerResponseType)

Get all finder names associated to an entity

Parameters:

entity - the JavaType representing the entity whose finder names should be returned.

controllerResponseType - (can be null)

Returns:

a List with the finder names.

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()