org.springframework.data.redis.hash

Class Jackson2HashMapper

java.lang.Object

org.springframework.data.redis.hash.Jackson2HashMapper

All Implemented Interfaces:

HashMapper<Object,String,Object>

public class Jackson2HashMapper
extends Object
implements HashMapper<Object,String,Object>

ObjectMapper based HashMapper implementation that allows flattening. Given an entity Person with an Address like below the flattening will create individual hash entries for all nested properties and resolve complex types into simple types, as far as possible.

Flattening requires all property names to not interfere with JSON paths. Using dots or brackets in map keys or as property names is not supported using flattening. The resulting hash cannot be mapped back into an Object.

Example

 class Person {
        String firstname;
        String lastname;
        Address address;
        Date date;
        LocalDateTime localDateTime;
 }

 class Address {
        String city;
        String country;
 }
 

Normal

Hash field	Value
firstname	Jon
lastname	Snow
address	{ "city" : "Castle Black", "country" : "The North" }
date	1561543964015
localDateTime	2018-01-02T12:13:14

Flat

Hash field	Value
firstname	Jon
lastname	Snow
address.city	Castle Black
address.country	The North
date	1561543964015
localDateTime	2018-01-02T12:13:14

Since:

1.8

Author:

Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor and Description
Jackson2HashMapper(boolean flatten) Creates new Jackson2HashMapper with default ObjectMapper.
Jackson2HashMapper(com.fasterxml.jackson.databind.ObjectMapper mapper, boolean flatten) Creates new Jackson2HashMapper.

Method Summary

Modifier and Type	Method and Description
Object	fromHash(Map<String,Object> hash) Convert a hash (map) to an object.
Map<String,Object>	toHash(Object source) Convert an object to a map that can be used with Redis hashes.

Methods inherited from class java.lang.Object

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

Constructor Detail

Jackson2HashMapper

public Jackson2HashMapper(boolean flatten)

Creates new Jackson2HashMapper with default ObjectMapper.

Parameters:

flatten -

Jackson2HashMapper

public Jackson2HashMapper(com.fasterxml.jackson.databind.ObjectMapper mapper,
                          boolean flatten)

Creates new Jackson2HashMapper.

Parameters:

mapper - must not be null.

flatten -

Method Detail

toHash

public Map<String,Object> toHash(Object source)

Description copied from interface: HashMapper

Convert an object to a map that can be used with Redis hashes.

Specified by:

toHash in interface HashMapper<Object,String,Object>

Returns:

fromHash

public Object fromHash(Map<String,Object> hash)

Description copied from interface: HashMapper

Convert a hash (map) to an object.

Specified by:

fromHash in interface HashMapper<Object,String,Object>

Returns: