org.oncoblocks.centromere.web.controller

Class RequestUtils

java.lang.Object

org.oncoblocks.centromere.web.controller.RequestUtils

public class RequestUtils
extends Object

Helper methods for processing API controller requests.

Author:

woemler

Constructor Summary

Constructors

Constructor and Description
RequestUtils()

Method Summary

Modifier and Type	Method and Description
static Object	convertParameter(Object param, Class<?> type) convertParameter(Object, Class, ConversionService)
static Object	convertParameter(Object param, Class<?> type, org.springframework.core.convert.ConversionService conversionService) Converts an object into the appropriate type defined by the model field being queried.
static List<Object>	convertParameterArray(Object[] params, Class<?> type) Converts an array of objects into the appropriate type defined by the model field being queried
static QueryCriteria	createCriteriaFromRequestParameter(String param, Object[] values, Class<?> type, Evaluation evaluation) Creates a QueryCriteria object based upon a request parameter and Evaluation value.
static List<String>	findAllParameters() Returns a list of the default query string parameters used by .
static List<String>	findDistinctParameters()
static List<String>	findOneParameters()
static Map<String,QueryParameterDescriptor>	getAvailableQueryParameters(Class<? extends Model<?>> model)
static Map<String,QueryParameterDescriptor>	getAvailableQueryParameters(Class<? extends Model<?>> model, boolean recursive) Inspects a Model class and returns all of the available and acceptable query parameter definitions, as a map of parameter names and QueryParameterDescriptor objects.
static Set<String>	getExcludedFieldsFromRequest(javax.servlet.http.HttpServletRequest request) Extracts the requested filtered fields parameter from a request.
static Set<String>	getFilteredFieldsFromRequest(javax.servlet.http.HttpServletRequest request) Extracts the requested filtered fields parameter from a request.
static List<QueryCriteria>	getQueryCriteriaFromFindDistinctRequest(Class<? extends Model<?>> model, javax.servlet.http.HttpServletRequest request)
static List<QueryCriteria>	getQueryCriteriaFromFindOneRequest(Class<? extends Model<?>> model, javax.servlet.http.HttpServletRequest request)
static List<QueryCriteria>	getQueryCriteriaFromFindRequest(Class<? extends Model<?>> model, javax.servlet.http.HttpServletRequest request)
static List<QueryCriteria>	getQueryCriteriaFromRequest(Map<String,QueryParameterDescriptor> paramMap, List<String> defaultParameters, javax.servlet.http.HttpServletRequest request) Extracts request parameters and matches them to available database query parameters, as defined in the model class definition.
static org.springframework.data.domain.Pageable	remapPageable(org.springframework.data.domain.Pageable pageable, Class<? extends Model<?>> model) Uses annotated Model class definitions to remap any request attribute names in a Pageable so that they match repository attribute names.
static String	remapParameterName(String param, Class<? extends Model<?>> model) Checks a request parameter name against all possible Model attributes, converting it to the appropriate repository field name for querying and sorting.
static boolean	requestContainsNonDefaultParameters(Collection<String> defaultParameters, Map<String,String[]> requestParams)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestUtils

public RequestUtils()

Method Detail

findAllParameters

public static List<String> findAllParameters()

Returns a list of the default query string parameters used by .

Returns:

findOneParameters

public static List<String> findOneParameters()

findDistinctParameters

public static List<String> findDistinctParameters()

getQueryCriteriaFromFindRequest

public static List<QueryCriteria> getQueryCriteriaFromFindRequest(Class<? extends Model<?>> model,
                                                                  javax.servlet.http.HttpServletRequest request)

getQueryCriteriaFromFindOneRequest

public static List<QueryCriteria> getQueryCriteriaFromFindOneRequest(Class<? extends Model<?>> model,
                                                                     javax.servlet.http.HttpServletRequest request)

getQueryCriteriaFromFindDistinctRequest

public static List<QueryCriteria> getQueryCriteriaFromFindDistinctRequest(Class<? extends Model<?>> model,
                                                                          javax.servlet.http.HttpServletRequest request)

requestContainsNonDefaultParameters

public static boolean requestContainsNonDefaultParameters(Collection<String> defaultParameters,
                                                          Map<String,String[]> requestParams)

getQueryCriteriaFromRequest

public static List<QueryCriteria> getQueryCriteriaFromRequest(Map<String,QueryParameterDescriptor> paramMap,
                                                              List<String> defaultParameters,
                                                              javax.servlet.http.HttpServletRequest request)

Extracts request parameters and matches them to available database query parameters, as defined in the model class definition.

Parameters:

request - HttpServletRequest

Returns:

getAvailableQueryParameters

public static Map<String,QueryParameterDescriptor> getAvailableQueryParameters(Class<? extends Model<?>> model,
                                                                               boolean recursive)

Inspects a Model class and returns all of the available and acceptable query parameter definitions, as a map of parameter names and QueryParameterDescriptor objects.

Parameters:

model -

Returns:

getAvailableQueryParameters

public static Map<String,QueryParameterDescriptor> getAvailableQueryParameters(Class<? extends Model<?>> model)

createCriteriaFromRequestParameter

public static QueryCriteria createCriteriaFromRequestParameter(String param,
                                                               Object[] values,
                                                               Class<?> type,
                                                               Evaluation evaluation)

Creates a QueryCriteria object based upon a request parameter and Evaluation value.

Parameters:

param -

values -

type -

evaluation -

Returns:

convertParameter

public static Object convertParameter(Object param,
                                      Class<?> type,
                                      org.springframework.core.convert.ConversionService conversionService)

Converts an object into the appropriate type defined by the model field being queried.

Parameters:

param -

type -

Returns:

convertParameter

public static Object convertParameter(Object param,
                                      Class<?> type)

convertParameter(Object, Class, ConversionService)

convertParameterArray

public static List<Object> convertParameterArray(Object[] params,
                                                 Class<?> type)

Converts an array of objects into the appropriate type defined by the model field being queried

Parameters:

params -

type -

Returns:

getFilteredFieldsFromRequest

public static Set<String> getFilteredFieldsFromRequest(javax.servlet.http.HttpServletRequest request)

Extracts the requested filtered fields parameter from a request.

Parameters:

request -

Returns:

getExcludedFieldsFromRequest

public static Set<String> getExcludedFieldsFromRequest(javax.servlet.http.HttpServletRequest request)

Extracts the requested filtered fields parameter from a request.

Parameters:

request -

Returns:

remapPageable

public static org.springframework.data.domain.Pageable remapPageable(org.springframework.data.domain.Pageable pageable,
                                                                     Class<? extends Model<?>> model)

Uses annotated Model class definitions to remap any request attribute names in a Pageable so that they match repository attribute names.

Parameters:

pageable - Pageable

Returns:

remapParameterName

public static String remapParameterName(String param,
                                        Class<? extends Model<?>> model)

Checks a request parameter name against all possible Model attributes, converting it to the appropriate repository field name for querying and sorting.

Parameters:

param -

Returns: