org.oncoblocks.centromere.core.util

Class QueryParameterUtil

java.lang.Object

org.oncoblocks.centromere.core.util.QueryParameterUtil

public class QueryParameterUtil
extends Object

TODO

Since:

0.4.2

Author:

woemler

Constructor Summary

Constructors

Constructor and Description
QueryParameterUtil()

Method Summary

Modifier and Type	Method and Description
static Map<String,QueryParameterDescriptor>	getAvailableQueryParameters(Class<? extends Model<?>> model)
static Map<String,QueryParameterDescriptor>	getAvailableQueryParameters(Class<? extends Model<?>> model, boolean useForeignKeyParams) Returns all available query parameters for a given model, optionally including parameters of any related models, as inferred by the presence of ForeignKey annotations.
static QueryParameterDescriptor	getDescriptorFromAlias(Alias alias, Field field) Accepts an Alias annotation and a Field reference and returns a single QueryParameterDescriptor instance describing an acceptable query parameter.
static List<QueryParameterDescriptor>	getDescriptorsFromAliases(Aliases aliases)
static List<QueryParameterDescriptor>	getDescriptorsFromAliases(Aliases aliases, Field field) Accepts an Aliases annotation and a Field reference and returns all of the QueryParameterDescriptor instances associated with the embedded Alias annotations.
static List<QueryParameterDescriptor>	getFieldDescriptors(Field field) Returns all valid query parameter descriptors from a given field, as defined by the default field name and available Alias and Aliases annotations.
static Map<String,QueryParameterDescriptor>	getForeignKeyModelParameters(Class<? extends Model<?>> model) Returns a map of QueryParameterDescriptor instances for models related to the given Model, inferred by the presence of ForeignKey annotations.
static Map<String,QueryParameterDescriptor>	getModelQueryParameters(Class<? extends Model<?>> model) Returns a mapping of all of a given Model class's available query parameters.
static Class<?>	getQueryableFieldType(Field field) Returns the type of the model field that the parameter argument will be converted to from a string.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryParameterUtil

public QueryParameterUtil()

Method Detail

getDescriptorFromAlias

public static QueryParameterDescriptor getDescriptorFromAlias(Alias alias,
                                                              Field field)

Accepts an Alias annotation and a Field reference and returns a single QueryParameterDescriptor instance describing an acceptable query parameter.

Parameters:

alias - annotation instance.

field - field reflection to which the annotation belongs.

Returns:

single query parameter descriptor object.

getDescriptorsFromAliases

public static List<QueryParameterDescriptor> getDescriptorsFromAliases(Aliases aliases,
                                                                       Field field)

Accepts an Aliases annotation and a Field reference and returns all of the QueryParameterDescriptor instances associated with the embedded Alias annotations.

Parameters:

aliases -

field -

Returns:

getDescriptorsFromAliases

public static List<QueryParameterDescriptor> getDescriptorsFromAliases(Aliases aliases)

getForeignKeyModelParameters

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

Returns a map of QueryParameterDescriptor instances for models related to the given Model, inferred by the presence of ForeignKey annotations.

Parameters:

model -

Returns:

getFieldDescriptors

public static List<QueryParameterDescriptor> getFieldDescriptors(Field field)

Returns all valid query parameter descriptors from a given field, as defined by the default field name and available Alias and Aliases annotations. Ignores synthetic fields. Fields annotated with Ignored will not have the default parameter created, but may have alias parameters created.

Parameters:

field -

Returns:

getQueryableFieldType

public static Class<?> getQueryableFieldType(Field field)

Returns the type of the model field that the parameter argument will be converted to from a string. If the model field is a collection, the parameterized type is used.

Parameters:

field -

Returns:

getModelQueryParameters

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

Returns a mapping of all of a given Model class's available query parameters.

Parameters:

model -

Returns:

getAvailableQueryParameters

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

Returns all available query parameters for a given model, optionally including parameters of any related models, as inferred by the presence of ForeignKey annotations.

Parameters:

model -

useForeignKeyParams -

Returns:

getAvailableQueryParameters

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