org.molgenis.dataexplorer.controller

Class DataExplorerController

java.lang.Object

org.molgenis.web.PluginController

org.molgenis.dataexplorer.controller.DataExplorerController

@Controller
 @RequestMapping(value="/plugin/dataexplorer")
 @SessionAttributes(value={"galaxyUrl","galaxyApiKey"})
public class DataExplorerController
extends org.molgenis.web.PluginController

Controller class for the data explorer.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID
static String	MOD_ANNOTATORS
static String	MOD_DATA
static String	MOD_ENTITIESREPORT
static String	URI

Fields inherited from class org.molgenis.web.PluginController

PLUGIN_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
DataExplorerController()

Method Summary

Modifier and Type	Method and Description
void	download(String dataRequestStr, javax.servlet.http.HttpServletResponse response)
void	exportToGalaxy(GalaxyDataExportRequest galaxyDataExportRequest, org.springframework.ui.Model model)
String	getDownloadFilename(String entityTypeId, LocalDateTime localDateTime, DataRequest.DownloadType downloadType)
String	getModule(String moduleId, String entityTypeId, org.springframework.ui.Model model)
ModulesConfigResponse	getModules(String entityTypeId) Returns modules configuration for this entity based on current user permissions.
ErrorMessageResponse	handleGalaxyDataExportException(GalaxyDataExportException e)
ErrorMessageResponse	handleRuntimeException(RuntimeException e)
String	init(String selectedEntityName, String selectedEntityId, org.springframework.ui.Model model) Show the explorer page
boolean	showCopy(String entityTypeId)
String	viewEntityDetails(String entityTypeId, String entityId, org.springframework.ui.Model model) Builds a model containing one entity and returns the entityReport ftl view
String	viewEntityDetailsById(String entityTypeId, String entityId, org.springframework.ui.Model model) Builds a model containing one entity and returns standalone report ftl view

Methods inherited from class org.molgenis.web.PluginController

getId, getPluginSettings, getUri

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

URI

public static final String URI

See Also:

Constant Field Values

MOD_ANNOTATORS

public static final String MOD_ANNOTATORS

See Also:

Constant Field Values

MOD_ENTITIESREPORT

public static final String MOD_ENTITIESREPORT

See Also:

Constant Field Values

MOD_DATA

public static final String MOD_DATA

See Also:

Constant Field Values

Constructor Detail

DataExplorerController

public DataExplorerController()

Method Detail

init

@RequestMapping(method=GET)
public String init(@RequestParam(value="entity",required=false)
                                               String selectedEntityName,
                                               @RequestParam(value="entityId",required=false)
                                               String selectedEntityId,
                                               org.springframework.ui.Model model)
                                        throws Exception

Show the explorer page

Returns:

the view name

Throws:

Exception

getModule

@RequestMapping(value="/module/{moduleId}",
                method=GET)
public String getModule(@PathVariable(value="moduleId")
                                                                                                String moduleId,
                                                                                                @RequestParam(value="entity")
                                                                                                String entityTypeId,
                                                                                                org.springframework.ui.Model model)

showCopy

@RequestMapping(value="/copy",
                method=GET)
 @ResponseBody
public boolean showCopy(@RequestParam(value="entity")
                                                                                                  String entityTypeId)

getModules

@RequestMapping(value="/modules",
                method=GET)
 @ResponseBody
public ModulesConfigResponse getModules(@RequestParam(value="entity")
                                                                                                                     String entityTypeId)

Returns modules configuration for this entity based on current user permissions.

download

@RequestMapping(value="/download",
                method=POST)
public void download(@RequestParam(value="dataRequest")
                                                                                     String dataRequestStr,
                                                                                     javax.servlet.http.HttpServletResponse response)
                                                                              throws IOException

Throws:

IOException

getDownloadFilename

public String getDownloadFilename(String entityTypeId,
                                  LocalDateTime localDateTime,
                                  DataRequest.DownloadType downloadType)

exportToGalaxy

@RequestMapping(value="/galaxy/export",
                method=POST)
 @ResponseStatus(value=OK)
public void exportToGalaxy(@RequestBody
                                                                                                                           GalaxyDataExportRequest galaxyDataExportRequest,
                                                                                                                           org.springframework.ui.Model model)
                                                                                                                    throws IOException

Throws:

IOException

viewEntityDetails

@RequestMapping(value="/details",
                method=POST)
public String viewEntityDetails(@RequestParam(value="entityTypeId")
                                                                                               String entityTypeId,
                                                                                               @RequestParam(value="entityId")
                                                                                               String entityId,
                                                                                               org.springframework.ui.Model model)
                                                                                        throws Exception

Builds a model containing one entity and returns the entityReport ftl view

Returns:

entity report view

Throws:

Exception - if an entity name or id is not found

viewEntityDetailsById

@RequestMapping(value="/details/{entityTypeId}/{entityId}",
                method=GET)
public String viewEntityDetailsById(@PathVariable(value="entityTypeId")
                                                                                                                            String entityTypeId,
                                                                                                                            @PathVariable(value="entityId")
                                                                                                                            String entityId,
                                                                                                                            org.springframework.ui.Model model)
                                                                                                                     throws Exception

Builds a model containing one entity and returns standalone report ftl view

Returns:

standalone report view

Throws:

Exception - if an entity name or id is not found

MolgenisDataAccessException - if an EntityType does not exist

handleGalaxyDataExportException

@ExceptionHandler(value=GalaxyDataExportException.class)
 @ResponseBody
 @ResponseStatus(value=BAD_REQUEST)
public ErrorMessageResponse handleGalaxyDataExportException(GalaxyDataExportException e)

handleRuntimeException

@ExceptionHandler(value=java.lang.RuntimeException.class)
 @ResponseBody
 @ResponseStatus(value=INTERNAL_SERVER_ERROR)
public ErrorMessageResponse handleRuntimeException(RuntimeException e)