Class JacksonMappingAwareSortTranslator

java.lang.Object

org.springframework.data.rest.webmvc.json.JacksonMappingAwareSortTranslator

All Implemented Interfaces:

SortTranslator

public class JacksonMappingAwareSortTranslator
extends Object
implements SortTranslator

Translator for Sort arguments that is aware of Jackson-Mapping on domain classes. Jackson field names are translated to PersistentProperty names. Domain class is looked up by resolving request URLs to mapped repositories. Sort translation is skipped if a domain class cannot be resolved.

Since:

5.0

Author:

Mark Paluch, Oliver Gierke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JacksonMappingAwareSortTranslator.SortTranslator	Translates Sort orders from Jackson-mapped field names to PersistentProperty names.

Constructor Summary

Constructors

Constructor	Description
JacksonMappingAwareSortTranslator(tools.jackson.databind.ObjectMapper objectMapper, Repositories repositories, DomainClassResolver domainClassResolver, PersistentEntities persistentEntities, Associations associations)	Creates a new JacksonMappingAwareSortTranslator for the given ObjectMapper, Repositories, DomainClassResolver and PersistentEntities.

Method Summary

Modifier and Type	Method	Description
Sort	translateSort(Sort input, MethodParameter parameter, NativeWebRequest webRequest)	Translates Jackson field names within a Sort to PersistentProperty property names.

Methods inherited from class Object

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

Constructor Details

JacksonMappingAwareSortTranslator

public JacksonMappingAwareSortTranslator(tools.jackson.databind.ObjectMapper objectMapper,
 Repositories repositories,
 DomainClassResolver domainClassResolver,
 PersistentEntities persistentEntities,
 Associations associations)

Creates a new JacksonMappingAwareSortTranslator for the given ObjectMapper, Repositories, DomainClassResolver and PersistentEntities.

Parameters:

objectMapper - must not be null.

repositories - must not be null.

domainClassResolver - must not be null.

persistentEntities - must not be null.

associations - must not be null.

Method Details

translateSort

public Sort translateSort(Sort input,
 MethodParameter parameter,
 NativeWebRequest webRequest)

Translates Jackson field names within a Sort to PersistentProperty property names.

Specified by:

translateSort in interface SortTranslator

Parameters:

input - must not be null.

parameter - must not be null.

webRequest - must not be null.

Returns:

a Sort containing translated property names or null the resulting Sort contains no properties.