io.crnk.legacy.queryParams

Class JsonApiQueryParamsParser

java.lang.Object

io.crnk.legacy.queryParams.DefaultQueryParamsParser

io.crnk.legacy.queryParams.JsonApiQueryParamsParser

All Implemented Interfaces:

QueryParamsParser

Deprecated.

make use of QuerySpec

@Deprecated
public class JsonApiQueryParamsParser
extends DefaultQueryParamsParser

A QueryParamsParser implementation which adheres to the JSON-API standard more strictly than the DefaultQueryParamsParser, at the expense of having less flexibility.

Constructor Summary

Constructors

Constructor and Description
JsonApiQueryParamsParser() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	filterQueryParamsByKey(QueryParamsParserContext context, java.lang.String queryKey) Deprecated. Filters provided query params to one starting with provided string key.
protected TypedParams<IncludedRelationsParams>	parseIncludedRelationsParameters(QueryParamsParserContext context) Deprecated. Important! Crnk implementation differs form JSON API definition of includes in order to fit standard query legacy serializing strategy and maximize effective processing of data.
protected TypedParams<SortingParams>	parseSortingParameters(QueryParamsParserContext context) Deprecated. Important! Crnk implementation differs form JSON API definition of sorting in order to fit standard query legacy serializing strategy and maximize effective processing of data.

Methods inherited from class io.crnk.legacy.queryParams.DefaultQueryParamsParser

buildPropertyListFromEntry, parse, parseFiltersParameters, parseGroupingParameters, parseIncludedFieldsParameters, parsePaginationParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonApiQueryParamsParser

public JsonApiQueryParamsParser()

Deprecated.

Method Detail

parseSortingParameters

protected TypedParams<SortingParams> parseSortingParameters(QueryParamsParserContext context)

Deprecated.

Description copied from class: DefaultQueryParamsParser

Important! Crnk implementation differs form JSON API definition of sorting in order to fit standard query legacy serializing strategy and maximize effective processing of data.

Sort params can be send with following format:
sort[ResourceType][property]([property])* = "asc|desc"

Examples of accepted sorting of resources:

• GET /tasks/?sort[tasks][name]=asc
• GET /project/?sort[projects][shortName]=desc&sort[users][name][firstName]=asc

Overrides:

parseSortingParameters in class DefaultQueryParamsParser

Parameters:

context - Don't know, didn't write the code

Returns:

TypedParams Map of sorting params passed to request grouped by type of document

parseIncludedRelationsParameters

protected TypedParams<IncludedRelationsParams> parseIncludedRelationsParameters(QueryParamsParserContext context)

Deprecated.

Description copied from class: DefaultQueryParamsParser

Important! Crnk implementation differs form JSON API definition of includes in order to fit standard query legacy serializing strategy and maximize effective processing of data.

Included field set params can be send with following format:
include[ResourceType] = "property(.property)*"

Examples of accepted sparse field sets of resources:

• GET /tasks/?include[tasks]=author
• GET /tasks/?include[tasks][]=author&include[tasks][]=comments
• GET /projects/?include[projects]=task&include[tasks]=comments

Overrides:

parseIncludedRelationsParameters in class DefaultQueryParamsParser

Parameters:

context - Don't know, didn't write the code

Returns:

TypedParams Map of sparse field set params passed to a request grouped by type of document

filterQueryParamsByKey

protected java.util.Map<java.lang.String,java.util.Set<java.lang.String>> filterQueryParamsByKey(QueryParamsParserContext context,
                                                                                                 java.lang.String queryKey)

Deprecated.

Filters provided query params to one starting with provided string key. This override also splits param values if they are contained in a comma-delimited list.

Overrides:

filterQueryParamsByKey in class DefaultQueryParamsParser

Parameters:

context - used to inspect the parameters of the current request

queryKey - Filtering key

Returns:

Filtered query params